docs: align v1.4.0 notes DX copy with the GitHub release - #13777
docs: align v1.4.0 notes DX copy with the GitHub release#13777dagil-nvidia wants to merge 2 commits into
Conversation
Drop the corrected-docs, CODEOWNERS, and whole-site zh-CN framing from the summary card and Developer Experience section. Signed-off-by: Dan Gil <dagil@nvidia.com>
github-actions
Bot
added
docs
documentation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| - **Simplified Chinese Docs Localization:** Registered all 13 existing zh-CN translations in the Fern nav under the hidden Additional Resources section so they publish at real URLs and the language switcher links resolve instead of serving soft-404 stubs ([#11088](https://github.com/ai-dynamo/dynamo/pull/11088)), then replaced the raw HTML switcher badge with a plain Markdown link and dropped duplicate body H1s on 5 translated pages ([#11148](https://github.com/ai-dynamo/dynamo/pull/11148)). Migrated the manual switcher to Fern native localization, moving translations to a `fern/translations/zh-CN` mirror tree with a `translations:` config that adds the header language dropdown and falls back to English for untranslated pages on the dev version ([#11161](https://github.com/ai-dynamo/dynamo/pull/11161)). | ||
| - **Tagged-Commit Release Snapshots:** Fixed the Fern docs release workflow to build versioned pages and navigation from the tagged commit's own docs, navigation, and converter instead of whatever content was on `main`, preventing release tags from publishing mismatched content, and added a local release dry-run script under `fern/` for pre-publish validation ([#11140](https://github.com/ai-dynamo/dynamo/pull/11140)). | ||
| - **Tabbed Navigation:** Kubernetes, the local CLI, recipes, developer material, and reference each have their own tab. Old URLs still work ([#10855](https://github.com/ai-dynamo/dynamo/pull/10855)). The SGLang, TensorRT-LLM, and vLLM multimodal deploy guides are back in the navigation ([#11064](https://github.com/ai-dynamo/dynamo/pull/11064)), and Kubernetes content lives in one place ([#12243](https://github.com/ai-dynamo/dynamo/pull/12243)). | ||
| - **Autogenerated API Documentation:** Python, Rust, and Kubernetes API pages are generated from source, so you can always find the most up-to-date information about the modules, crates, and CRDs in that release. Search finds symbols, and each page copies as Markdown ([#12110](https://github.com/ai-dynamo/dynamo/pull/12110)). CRD pages link to the Full API Reference ([#12815](https://github.com/ai-dynamo/dynamo/pull/12815)). |
There was a problem hiding this comment.
🔍 Same PR cited for two unrelated features
#12110 is cited on dynamo-v1-4-0.mdx for API-docs search/Markdown-copy and again on line 402 for the Nightly Releases page. The PR description identifies #12110 as the nightly-releases PR, so its use on line 398 can be a stale citation. Worth verifying against the actual PR.
Was this helpful? React with 👍 or 👎 to provide feedback.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. WalkthroughThe release page updates localization details and expands documentation release notes. It adds separate sections for the documentation website and documentation content, including navigation, generated references, release metadata, and technical documentation updates. ChangesDocumentation release content
Merge Risk: ⚪ Minimal · up to This is a localized documentation-only update, and no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) Comment |
![dynamo-review-agent[bot]](https://avatars.githubusercontent.com/u/201626793?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ec0f39071c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **Tagged-Commit Release Snapshots:** Fixed the Fern docs release workflow to build versioned pages and navigation from the tagged commit's own docs, navigation, and converter instead of whatever content was on `main`, preventing release tags from publishing mismatched content, and added a local release dry-run script under `fern/` for pre-publish validation ([#11140](https://github.com/ai-dynamo/dynamo/pull/11140)). | ||
| - **Tabbed Navigation:** Kubernetes, the local CLI, recipes, developer material, and reference each have their own tab. Old URLs still work ([#10855](https://github.com/ai-dynamo/dynamo/pull/10855)). The SGLang, TensorRT-LLM, and vLLM multimodal deploy guides are back in the navigation ([#11064](https://github.com/ai-dynamo/dynamo/pull/11064)), and Kubernetes content lives in one place ([#12243](https://github.com/ai-dynamo/dynamo/pull/12243)). | ||
| - **Autogenerated API Documentation:** Python, Rust, and Kubernetes API pages are generated from source, so you can always find the most up-to-date information about the modules, crates, and CRDs in that release. Search finds symbols, and each page copies as Markdown ([#12110](https://github.com/ai-dynamo/dynamo/pull/12110)). CRD pages link to the Full API Reference ([#12815](https://github.com/ai-dynamo/dynamo/pull/12815)). | ||
| - **Compatibility and Feature Matrices:** The Compatibility page is built around a version picker: select a Dynamo release and see backend, NIXL, CUDA, driver, GPU, OS, and architecture for that release ([#12215](https://github.com/ai-dynamo/dynamo/pull/12215), [#12529](https://github.com/ai-dynamo/dynamo/pull/12529)), plus a per-backend feature matrix and pairwise feature-interaction matrices ([#12529](https://github.com/ai-dynamo/dynamo/pull/12529)). A KV router offloading matrix covers backends and cache tiers ([#11973](https://github.com/ai-dynamo/dynamo/pull/11973)). |
There was a problem hiding this comment.
When a reader selects any release other than CURRENT_VERSION (currently v1.4.1), CompatibilityHero shows backend, NIXL, CUDA, and driver data but hides the entire GPU/OS/architecture block behind selectedVersion === CURRENT_VERSION (docs/fern/components/CompatibilityHero.tsx:302-334). Selecting v1.4.0 therefore does not show the last three fields promised here; narrow this claim or provide platform data for every selectable release.
Useful? React with 👍 / 👎.
| - **Autogenerated API Documentation:** Python, Rust, and Kubernetes API pages are generated from source, so you can always find the most up-to-date information about the modules, crates, and CRDs in that release. Search finds symbols, and each page copies as Markdown ([#12110](https://github.com/ai-dynamo/dynamo/pull/12110)). CRD pages link to the Full API Reference ([#12815](https://github.com/ai-dynamo/dynamo/pull/12815)). | ||
| - **Compatibility and Feature Matrices:** The Compatibility page is built around a version picker: select a Dynamo release and see backend, NIXL, CUDA, driver, GPU, OS, and architecture for that release ([#12215](https://github.com/ai-dynamo/dynamo/pull/12215), [#12529](https://github.com/ai-dynamo/dynamo/pull/12529)), plus a per-backend feature matrix and pairwise feature-interaction matrices ([#12529](https://github.com/ai-dynamo/dynamo/pull/12529)). A KV router offloading matrix covers backends and cache tiers ([#11973](https://github.com/ai-dynamo/dynamo/pull/11973)). | ||
| - **Versioned Docs Per Release:** Each release line has its own page with highlights, install commands, and upgrade pins from the previous version. | ||
| - **Known Issues and Deprecations:** Known issues and deprecation notices for every Dynamo release are logged on dedicated pages, so you look them up there instead of hunting through each release's notes. The v1.4.0 deprecations section is on that ledger ([#12775](https://github.com/ai-dynamo/dynamo/pull/12775)). |
There was a problem hiding this comment.
For users looking up v1.2.0 or older, neither dedicated ledger contains the promised release sections: known-issues.mdx has headings only for v1.4.0, v1.3.1, and v1.3.0, while deprecations.mdx has only v1.4.0 and v1.3.0. This is not because those releases had no entries—the generated statistics record 5/11 breaking changes/known issues for v1.2.0, 8/20 for v1.1.0, and 41/14 for v1.0.0 (release-history.mdx:33-39). Narrow the wording to the covered releases or populate the missing ledger sections.
Useful? React with 👍 / 👎.
The Compatibility hero renders GPU, OS, and architecture only when the selected version is the current release, so the per-release promise overstated what the picker shows for older releases. Signed-off-by: Dan Gil <dagil@nvidia.com>
1 participant
Summary
nightly-releases.md), not docs: address Dynamo docs nav and RL feedback #12436.Test plan
Summary by CodeRabbit