feat: Add Usage section and reorganize documentation navigation #119
Conversation
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
- Updated .gitignore to include usage markdown files. - Modified docusaurus.config.js to add a new sidebar for usage documentation. - Introduced remote-content/remote-sources/usage/usage-generator.js to generate usage documentation from specific source files, ensuring alignment with release versions. - Updated remote-content/remote-content.js to integrate usage sources into the content generation process. Signed-off-by: Pete Cheslock <[email protected]>
- Added `sidebarLabel` entries for multiple components in `components-data.yaml` to improve clarity in documentation. - Updated `components-generator.js` to utilize the new `sidebarLabel` field when generating content, ensuring consistent display names across the documentation. Signed-off-by: Pete Cheslock <[email protected]>
Signed-off-by: Pete Cheslock <[email protected]>
Signed-off-by: Pete Cheslock <[email protected]>
✅ Deploy Preview for elaborate-kangaroo-25e1ee ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
|
Member
Author
|
I can't think of a better term than "Usage" for basically post deployment tasks but if anyone has any ideas then lmk. |
jjasghar
approved these changes
Nov 19, 2025
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.
Adds a new "Usage" section for post-deployment docs syncing from the readme's in the https://github.com/llm-d/llm-d/tree/main/docs folder.
Changes
New Usage Section
docs/usage/section with usage docs (from https://github.com/llm-d/llm-d/tree/main/docs):usage-generator.jsfollowing project remote sync patternsNavigation Improvements
Component Documentation
sidebarLabelfield tocomponents-data.yamlfor custom component display namescomponents-generator.jsto support custom labels with auto-generation fallbackcategoryfield from component configsOther
.gitignoreto exclude synced usage docs