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

Have file structure mirror the documentation page structure #282

Open
lucyleeow opened this issue Nov 30, 2023 · 2 comments
Open

Have file structure mirror the documentation page structure #282

lucyleeow opened this issue Nov 30, 2023 · 2 comments
Labels

Comments

@lucyleeow
Copy link
Collaborator

🧰 Task

docs/guides contains items that fall under the "In-depth explanations" section of the docs. I find this confusing because we also have a "How-to guides" section of the docs.

Could we rename docs/guides/ to docs/explanations/ or something similar?

@lucyleeow lucyleeow added the task label Nov 30, 2023
@lucyleeow lucyleeow changed the title Ren Rename docs/guides to docs/explanations Nov 30, 2023
@DragaDoncila
Copy link
Contributor

@lucyleeow yeah i think it would be good for the directory structure to more closely mimic where things end up in the website. I don't know of any good reason not to do this.

@lucyleeow lucyleeow changed the title Rename docs/guides to docs/explanations Have file structure mirror the documentation page structure Dec 2, 2023
@lucyleeow
Copy link
Collaborator Author

I've amended this issue to be more general, so it is easier to navigate the docs files.

AFAICT this would involve:

  • renaming docs/guides/ to docs/explanations/
  • moving docs/tutorials/fundamentals/ ('Usage' -> 'Getting started') to docs/getting_started/

The docs/further-resources/ file doesn't exactly mirror the docs but I think this is fine to leave.

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

No branches or pull requests

2 participants