docs(fern): lead nightly chips with the engine version - #13702
Conversation
A stable chip reads "0.5.16 / Dynamo 1.4.1" -- engine version on top, Dynamo version beneath. A nightly chip read the other way round, leading with "1.4.0.dev20260803" over "latest nightly", so the same row changed meaning depending on the channel. Both selectors now put the engine version first on every channel and carry the Dynamo version underneath. The row label loses its nightly special case for the same reason: it said "Dynamo nightly" while the chip below it now leads with an SGLang or vLLM version. Entries with no Dynamo version keep their old subtitle: the TensorRT-LLM nightly has no pinned wheel, so it still reads "1.3.0rc24 / latest nightly", and source builds still read "from main". This is presentation only. The engine version shown for a nightly comes from the single MAIN_TOT pin, so all three nightlies report the same one -- what that pin should say per nightly is a data question, not a display one. Signed-off-by: Harry Kim <harryk@nvidia.com>
|
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 (2)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. WalkthroughBoth selectors now use the selected backend version for version rows and chips. Metadata follows a consistent priority for source status, Dynamo version, latest-nightly status, and nightly date or fallback labels. ChangesVersion Label Consistency
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change makes nightly selector labels and version chips consistently lead with the engine version; no actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
Overview:
The nightly chip in both install selectors read the opposite way round from the stable chip. Stable shows the engine version on top with the Dynamo version beneath; nightly led with the Dynamo dev version and put
latest nightlyunderneath, so the same row changed meaning depending on which channel you were on.Both selectors now lead with the engine version on every channel.
Details:
Before → after (SGLang, nightly):
DYNAMO NIGHTLYSGLANG VERSIONStable is unchanged and was already 0.5.16 ·
Dynamo 1.4.1.The row label loses its nightly special case for the same reason: it read "Dynamo nightly" while the chip below it now leads with an SGLang or vLLM version.
Applied to
InstallSelector(CLI quickstart) andKubernetesContainerSelector(Kubernetes quickstart), which carried the display logic verbatim — the point of the change is that the two agree.Entries with no Dynamo version keep their existing subtitle. The TensorRT-LLM nightly publishes no pinned wheel, so it still reads 1.3.0rc24 ·
latest nightly, and source builds still readfrom main.Where should the reviewer start?
docs/fern/components/InstallSelector.tsx— thedisplayVersion/displayMetapair.KubernetesContainerSelector.tsxgets the identical edit.Presentation only — two data problems are NOT fixed here
Both are with the ops team; flagging so the diff isn't mistaken for a fix.
The engine version is the same across all three nightlies. It comes from the single
MAIN_TOTtip-of-main pin per backend (sglang: 0.5.18,vllm: 0.27.1), which is not recorded per nightly build — so the Aug 3 / Aug 2 / Jul 30 chips all show0.5.18even if those builds shipped different engine versions. Recording it per entry inNIGHTLY_BUILDSis the real fix. That list is also hand-maintained and its newest entry is Aug 3.Kubernetes still offers only one nightly, and that is correct today. Its command uses the floating
dynamo-planner:nightlytag, and the operator CRD validatesruntimeVersionOverrideagainst^\d+\.\d+\.\d+$, so1.4.0.dev20260802would be rejected — all three nightlies would render an identical command. The CLI can offer three because wheels are published per date.Validation
Rendered against a local
fern docs devserver, exercised by clicking through the widget:SGLang version→0.5.18 / Dynamo 1.4.0.dev20260803,…802,…730; vLLM →0.27.1 / ….vLLM version→0.27.1 / Dynamo 1.4.0.dev20260803.1.3.0rc24 / latest nightly.fern check0 errors;check_style_components.pyandcheck_asset_paths.pypass.Related Issues
🚫 This PR is NOT linked to an issue:
Summary by CodeRabbit