Auto-generate User Manual landing page#5260
Open
Specky26846 wants to merge 6 commits into
Open
Conversation
Specky26846
changed the title
Not part of this PR
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
1 participant
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.
Change Description
Adds a dropdown table of contents to the User Manual landing page (index.md) that will automatically update with new documentation additions to the folder. This uses the mkdocs-gen-files plugin and a new Python script that runs when the User Manual folder is built. The .nav.yml folder in the docs folder is used as the source of truth for the newly generated index.md, which is consistent with the rest of the website.
Rationale
The previous User Manual landing page was very primitive and did not have links to individual pages or a detailed Table of Contents.
Testing/Review Recommendations
Tested locally by creating a dummy User Manual subfolder with dummy documentation inside, and the User Manual landing page updated appropriately.
Future Work
Taking suggestions on making this look nicer or any other features may be good to include for the landing page.
AI Usage (see policy)
Was used to generate a lot of the gen_user_manual.py script, such as the helper functions and f.write statements. Actual architecture designed myself.