Developer suggestion: Nest our documentation in sub-folders #966
Labels
documentation
Improvements or additions to documentation
Maintenance
Refactoring or maintenance of a code or function
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.md
quickstart-pdf.md
there is
quickstart/websites.md
quickstart/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
The text was updated successfully, but these errors were encountered: