Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Developer suggestion: Nest our documentation in sub-folders #966

Open
choldgraf opened this issue Mar 9, 2024 · 0 comments
Open

Developer suggestion: Nest our documentation in sub-folders #966

choldgraf opened this issue Mar 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation Maintenance Refactoring or maintenance of a code or function

Comments

@choldgraf
Copy link
Collaborator

choldgraf commented Mar 9, 2024

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

@choldgraf choldgraf added documentation Improvements or additions to documentation Maintenance Refactoring or maintenance of a code or function labels Mar 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Maintenance Refactoring or maintenance of a code or function
Projects
None yet
Development

No branches or pull requests

1 participant