Sync the main component repos for llm-d and render in the main "what is llm-d" architecture page #72
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
✅ Deploy Preview for elaborate-kangaroo-25e1ee ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Pete Cheslock <[email protected]>
- Updated .gitignore to exclude new architecture and component documentation files. - Expanded CONTRIBUTING.md with detailed guidelines for contributing to the llm-d website, including a quick guide for documentation changes and types of content. - Modified docusaurus.config.js to correct links for architecture documentation. - Added new remote content integration for architecture and component documentation, allowing automatic syncing from the main llm-d repository. - Removed outdated local documentation files to streamline content management. Signed-off-by: Pete Cheslock <[email protected]>
- Updated CONTRIBUTING.md to clarify directory structure for new content types and provided examples for copying templates. - Expanded remote-content/README.md with detailed instructions on content organization and configuration. - Introduced new remote content sources for architecture, community, and guide documentation, allowing for automatic syncing from the llm-d repository. - Added multiple new files for community guidelines, security policies, and various guide topics to improve documentation accessibility. Signed-off-by: Pete Cheslock <[email protected]>
Signed-off-by: Pete Cheslock <[email protected]>
- Renamed and unified transformation functions to ensure all relative links point back to the source repository. - Updated documentation comments for clarity and accuracy. - Deprecated previous transform functions in favor of a single, cohesive implementation. Signed-off-by: Pete Cheslock <[email protected]>
…rams - Added a comprehensive overview of the Remote Content Plugin System, including file organization and processing flow. - Introduced mermaid diagrams to illustrate the system architecture and detailed content transformation steps. - Expanded documentation to clarify the auto-generation of component documentation and integration with Docusaurus. Signed-off-by: Pete Cheslock <[email protected]>
Signed-off-by: Pete Cheslock <[email protected]>
Signed-off-by: Pete Cheslock <[email protected]>
- Introduced a new remote content source for the precise prefix cache aware guide, enabling automatic fetching and transformation of the README.md from the llm-d-infra repository. - Updated remote-content.js to include the new source in the plugin system. Signed-off-by: Pete Cheslock <[email protected]>
- Updated the `fixImages` function to accept a `sourceDir` parameter, allowing for correct resolution of relative paths based on the source file's directory. - Modified the `transformRepo` function to pass the `sourcePath` to the image and link transformation functions, ensuring all relative links point accurately to the source repository. - Adjusted content transformation logic in the guide examples to accommodate the new `sourcePath` parameter. Signed-off-by: Pete Cheslock <[email protected]>
petecheslock
force-pushed
the
feat/architecture-update
branch
from
f6ae045 to
df687fa
Compare
Signed-off-by: Pete Cheslock <[email protected]>
|
@jjasghar checking this branch - using the link checker the only broken links its showing are going to be fixed when we merge in this PR llm-d-incubation/llm-d-infra#134 - So this is ready to go. |
jjasghar
approved these changes
Aug 1, 2025
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 update introduces a robust architecture for automatically syncing documentation from remote GitHub repositories, ensuring that the site always reflects the latest information from source projects.
The remote content system now features a modular structure, with clear separation between architecture, guide, and community content sources. Each content source is configured for automatic transformation, attribution, and integration into the Docusaurus site.
The README for the remote content system has been thoroughly updated to include detailed mermaid diagrams that visually explain the flow of content from remote repositories through transformation utilities and into the final documentation.
The documentation now provides a comprehensive overview of the system’s architecture, the transformation pipeline, and clear instructions for adding new content sources or components.
Additionally, the update streamlines the process for contributors by clarifying the steps required to add or update remote content, and by providing troubleshooting guidance for common issues.