Add support for nested guide directories and clarify branch sync strategy#118
Conversation
✅ Deploy Preview for elaborate-kangaroo-25e1ee ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@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. |
|
@liu-cong Direct URLs The issue on the tab group is that you need closing "```" for the code block: https://github.com/llm-d/llm-d/blob/liu-cong-debug/guides/prefix-cache-storage/cpu/README.md?plain=1#L43 |
f794e65 to
6af7508
Compare
|
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>
6af7508 to
5353f0e
Compare
…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>
- 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>
Signed-off-by: Pete Cheslock <pete.cheslock@redhat.com>
|
Separate PR opened for the broken links - llm-d-incubation/llm-d-infra#245 |
Changes
Nested guide support - Added optional
targetFilenameparameter toDYNAMIC_GUIDESinguide-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.Branch testing workflow - Updated
components-data.yamlto support testing unreleased content by temporarily settingrelease.versionto a feature branch name (currentlyliu-cong-debugfor validation).Documentation improvements:
RELEASE_INFO.versionmainbranch viaCOMMON_REPO_CONFIGStargetFilenameusageTesting
Set
release.version: liu-cong-debugincomponents-data.yamland runnpm startto verify branch-based content sync works correctly.Follow-up
Revert
release.versionback to the official release tag (e.g.,v0.3.1) before merging to production.