search

seas-computing / react-boilerplate

Starting point for react-based projects at SEAS computing
0 stars 1 forks source link

Restructure docs #17

Open rmainwork opened 5 years ago

rmainwork commented 5 years ago

Current boilerplate is documented, but the code is structured in such a way as to make it somewhat difficult to navigate and read. This is because Typedoc expects things to be namespaced using Parent.Child syntax rather than parent/child. Additionally, Typedoc typically documents each individual file as it's own module by default leading to messy documentation as seen below.

image

Instead, a better alternative is to add docblocks to elements where appropriate and break things up into modules - resulting in something like this: image

image

chrxr commented 4 years ago

@rmainseas Can this issue be closed now?

rmainwork commented 4 years ago

I don't think so. The end goal of this issue is to break the docs up into smaller modules to help separate things out a big more. This is contingent upon https://github.com/christopherthielen/typedoc-plugin-external-module-name/issues/332 being fixed(which from the sounds of the comments on that issue may be the case, but it may be worth taking some time to revisit this briefly to see). The changes in #18 were just a stop-gap until the resolution of https://github.com/christopherthielen/typedoc-plugin-external-module-name/issues/332 so that the documentation was somewhat readable.