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

Flatten documentation root for single-module documentation #10

Open
ParadoxPixel opened this issue Jun 27, 2024 · 0 comments
Open

Flatten documentation root for single-module documentation #10

ParadoxPixel opened this issue Jun 27, 2024 · 0 comments
Labels
website generation Issues related to the backend (generating the static site)

Comments

@ParadoxPixel
Copy link
Collaborator

Currently every documentation website includes an index page which functions as the root of the documentation listing all documented modules and providing a nice entry into them. For single-module documentation it would however be prefered to not have this index and rather step into the single module directly. This results in a nicer user experience as it skips an unnecessary step in navigating the documentation.

The expected behaviour would be:

  1. In case of multiple modules keep the index page and navigation tree as is.
  2. In case of a single module flatten the documentation to have the only module be the root.
@ParadoxPixel ParadoxPixel added the website generation Issues related to the backend (generating the static site) label Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website generation Issues related to the backend (generating the static site)
Projects
None yet
Development

No branches or pull requests

1 participant