docs: change documentation hierachy to make space for adding more pages#47
Open
docs: change documentation hierachy to make space for adding more pages#47
Conversation
957ff44 to
bba4695
Compare
Collaborator
Author
|
@MauritsBleeker can you take a look at this? |
Ndles
approved these changes
Feb 11, 2026
Member
|
thanks for making the adjustments, checked it locally - looks good 👍 |
|
Docs publish only on push to main/dev-refactoring. Live site: https://noether-docs.emmi.ai/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation index is currently duplicated across the index and the index pages of subpages. In the main index we linked to each page in the guides section, and did this again in the index for the guides. The guides/index is also only linked on the main index and doesn't contain more information than already found in the sidebar which is always visible.
This setup doesn't make it easy to add more pages, as I found when adding documentation for the tracker docs.
My proposal now is to add more information to the sub-index pages that for the
noetherandtutorialsections and remove the sublinks there, for the guides which right now is the biggest section, we can just use the link to guides/index and have the subpages linked there, this makes the section collapsible which reduces visual clutter and avoids duplication of the links. Then for the reference section I remove the index completely because it just contains two links that were already linked in the sidebarSome other additons for smoother docs
imported-membersin the autoapi generation: this shows re-exports directly in the re-exported hierachy. E.g. noether.core.callbacks.base.CallbackBase that is reexported as noether.core.callbacks.CallbackBase now shows up on the noether.core.callbacks page already. This makes it easier to hide the "internal" modules. This was also the reason some of the links generated by autoapi based on the type-hints were not working because we would use the re-exported import internally as well that did not have a documentation page.