Skip to content

Add support for nested guide directories and clarify branch sync strategy#118

Merged
jjasghar merged 7 commits intollm-d:mainfrom
petecheslock:feat/support-remote-guides-in-dirs
Dec 1, 2025
Merged

Add support for nested guide directories and clarify branch sync strategy#118
jjasghar merged 7 commits intollm-d:mainfrom
petecheslock:feat/support-remote-guides-in-dirs

Conversation

@petecheslock
Copy link
Copy Markdown
Member

Changes

  1. Nested guide support - Added optional targetFilename parameter to DYNAMIC_GUIDES in guide-generator.js, allowing guides from nested directories (e.g., prefix-cache-storage/cpu/README.md) to render as top-level sidebar entries instead of nested folders.

  2. Branch testing workflow - Updated components-data.yaml to support testing unreleased content by temporarily setting release.version to a feature branch name (currently liu-cong-debug for validation).

  3. Documentation improvements:

    • Added "Understanding Versioned vs. Always-Current Content" section explaining the dual sync strategy
    • Documented how versioned content (guides, architecture, components) pulls from release tags via RELEASE_INFO.version
    • Documented how community docs always sync from main branch via COMMON_REPO_CONFIGS
    • Added "Testing content from a feature branch" workflow
    • Added "Supporting remote guides from nested directories" guide with targetFilename usage

Testing

Set release.version: liu-cong-debug in components-data.yaml and run npm start to verify branch-based content sync works correctly.

Follow-up

Revert release.version back to the official release tag (e.g., v0.3.1) before merging to production.

@petecheslock petecheslock added the hold PRs that are blocked on design, other features, release cycle, etc. label Nov 17, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 17, 2025

Deploy Preview for elaborate-kangaroo-25e1ee ready!

Name Link
🔨 Latest commit 94fb016
🔍 Latest deploy log https://app.netlify.com/projects/elaborate-kangaroo-25e1ee/deploys/692e094163687800089aeaf8
😎 Deploy Preview https://deploy-preview-118--elaborate-kangaroo-25e1ee.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@petecheslock petecheslock self-assigned this Nov 17, 2025
@petecheslock
Copy link
Copy Markdown
Member Author

@liu-cong Check out this branch with your changes incorporated to add those 2 new guides. After those guides are merged and released we can then revert the test commit (e07366839c20217805c7a8994cd60335daa2d421) and then merge this with the release.

Comment thread remote-content/remote-sources/components-data.yaml Outdated
Comment thread remote-content/remote-sources/guide/guide-generator.js Outdated
@petecheslock petecheslock force-pushed the feat/support-remote-guides-in-dirs branch 2 times, most recently from f794e65 to 6af7508 Compare November 20, 2025 19:20
@petecheslock petecheslock marked this pull request as draft November 20, 2025 19:22
@petecheslock petecheslock changed the title [DO NOT MERGE] Add support for nested guide directories and clarify branch sync strategy [Hold for next llm-d release] Add support for nested guide directories and clarify branch sync strategy Nov 20, 2025
@petecheslock
Copy link
Copy Markdown
Member Author

Hold this until the new docs are included in the next llm-d release.

Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
…dynamic guides

- Updated README.md to include instructions for configuring remote guides from nested directories, detailing the use of `targetFilename` for top-level page generation.
- Modified guide-generator.js to add new dynamic guides for 'Prefix Cache Storage' and 'Prefix Cache Storage - CPU', including sidebar positions and descriptions.

Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
@petecheslock petecheslock force-pushed the feat/support-remote-guides-in-dirs branch from 6af7508 to 5353f0e Compare November 21, 2025 20:00
…tation

- Renamed 'prefix-cache-storage' to 'tiered-prefix-cache' in guide-generator.js, updating titles and target filenames accordingly.
- Adjusted .gitignore to reflect the new directory structure for tiered prefix cache documentation.

Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
@petecheslock petecheslock marked this pull request as ready for review December 1, 2025 18:40
- Updated release information in components-data.yaml to reflect version v0.4.0, including release date and URL.
- Modified sidebar labels for several components to remove quotes for consistency.
- Updated version numbers for llm-d-modelservice and llm-d-infra components.
- Enhanced regex in sync-release.mjs to capture additional version formats.

Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
@petecheslock petecheslock changed the title [Hold for next llm-d release] Add support for nested guide directories and clarify branch sync strategy Add support for nested guide directories and clarify branch sync strategy Dec 1, 2025
Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
@petecheslock
Copy link
Copy Markdown
Member Author

Separate PR opened for the broken links - llm-d-incubation/llm-d-infra#245

@jjasghar jjasghar merged commit 1e31243 into llm-d:main Dec 1, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hold PRs that are blocked on design, other features, release cycle, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants