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

Better explanation on the usage of docs/content folder #340

Open
tang-mm opened this issue Feb 18, 2025 · 0 comments
Open

Better explanation on the usage of docs/content folder #340

tang-mm opened this issue Feb 18, 2025 · 0 comments

Comments

@tang-mm
Copy link
Contributor

tang-mm commented Feb 18, 2025

The current directory structure places the starter pack documentation under docs/content directory, and the main index page in the docs/ level.

.. toctree::
   :hidden:
   :maxdepth: 2

   Set up the documentation </content/set-up>
   /content/customise
   /content/rtd
   /content/update
   /content/automatic_checks
   /content/contributing

However, when creating new documentation projects from this repository, there is no explanation of the content folder and how users should organize their own documentation files. If users follow the practices in the existing folder, it results in generating a content/ segment in all the documentation pages:

  • Current result: <domain>/docs/content/tutorial
  • Expected result: <domain>/docs/tutorial

A clearer guidance is needed on how to organize documentation files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant