How-To Documentation Restructure and Landing Page#5266
Open
Specky26846 wants to merge 12 commits into
Open
Conversation
Specky26846
changed the title
Specky26846
force-pushed
the
how-to-doc-upgrade
branch
from
3af2086 to
1c2a140
Compare
thomas-bc
reviewed
Jun 11, 2026
Collaborator
There was a problem hiding this comment.
the file path gets transcribed to the URL on the website. For example, this page would now be fprime.jpl.nasa.gov/latest/docs/how-to/develop-your-project/data-products.md
I'd recommend we try to make the subdirectory names shorter, for example
develop-your-project -> dev
gds-and-operations -> ops
integrate-..... -> idk, maybe build ?
test-your-project -> test
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
2 participants
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
Restructuring the How-To documentation folder and its landing page. I divided the existing How-To guides into four categories. I then implemented drop-down menus on the How-To landing page with link to each individual document. This landing page now automatically updates when new documentation is added and the website is rebuilt.
Rationale
Previous How-To Guides landing page had cards that needed to be manually updated when new documentation was added, and there was no orgnaization.
Testing/Review Recommendations
Tested locally using
mkdocs serve, and uses the same Python script with modifications as the User Manual landing page.Future Work
Once This PR and #5260 are merged, I will start on migrating the F Prime website as a whole from MkDocs (which is no longer being supported) to Zensical (a newer tool supported by the same developers).
AI Usage (see policy)
Some AI used only for file path debugging, but mostly copied over the python script from the User Manual landing page.