mystmd
mystmd copied to clipboard
Developer suggestion: Nest our documentation in sub-folders
trafficstars
I was trying to wrap my head around the documentation here, and found it confusing to figure out how the file structure of the docs/ folder maps on to the nested structure of the docs at mystmd.org/guide. In many projects I've been involved with, they use a nested folder structure in order to make it easier to conceptually group the source files for pages in the documentation.
So for example, rather than:
quickstart-websites.mdquickstart-pdf.md
there is
quickstart/websites.mdquickstart/pdf.md
I wanted to see if there is a reason for why all of the docs are in a single flat hierarchy in the docs/ folder. If there's not a strong reason, is anybody opposed to PRs that include docs that are in nested folders?
References
- This is blocked on #670