Skip to content

docs(fern): lead nightly chips with the engine version - #13702

Open
harryskim wants to merge 1 commit into
mainfrom
docs/nightly-engine-version-first
Open

docs(fern): lead nightly chips with the engine version#13702
harryskim wants to merge 1 commit into
mainfrom
docs/nightly-engine-version-first

Conversation

@harryskim

@harryskim harryskim commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

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 nightly underneath, 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):

Row label Chip
Before DYNAMO NIGHTLY 1.4.0.dev20260803 · latest nightly
After SGLANG VERSION 0.5.18 · Dynamo 1.4.0.dev20260803

Stable 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) and KubernetesContainerSelector (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 read from main.

Where should the reviewer start?

docs/fern/components/InstallSelector.tsx — the displayVersion / displayMeta pair. KubernetesContainerSelector.tsx gets 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_TOT tip-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 show 0.5.18 even if those builds shipped different engine versions. Recording it per entry in NIGHTLY_BUILDS is 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:nightly tag, and the operator CRD validates runtimeVersionOverride against ^\d+\.\d+\.\d+$, so 1.4.0.dev20260802 would 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 dev server, exercised by clicking through the widget:

  • CLI nightly: SGLang version0.5.18 / Dynamo 1.4.0.dev20260803, …802, …730; vLLM → 0.27.1 / ….
  • Kubernetes nightly: vLLM version0.27.1 / Dynamo 1.4.0.dev20260803.
  • TensorRT-LLM nightly (no Dynamo version in data) falls back to 1.3.0rc24 / latest nightly.
  • Stable and source channels unchanged on both pages.
  • fern check 0 errors; check_style_components.py and check_asset_paths.py pass.

Related Issues

🚫 This PR is NOT linked to an issue:

  • Confirmed — no related issue

Open in Devin Review

Summary by CodeRabbit

  • Bug Fixes
    • Version labels in installation and Kubernetes container selectors now consistently reflect the selected backend version, regardless of release channel.
    • Version metadata now prioritizes available Dynamo version information and clearly indicates source status, latest nightly builds, nightly dates, or fallback details.
    • Resolved inconsistent labeling that could incorrectly display “Dynamo nightly” for nightly channels.

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>
@harryskim
harryskim requested a review from a team as a code owner August 23, 2026 23:41
@copy-pr-bot

copy-pr-bot Bot commented Aug 23, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions Bot added docs documentation Improvements or additions to documentation labels Aug 23, 2026

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f614a53d-f2e2-4847-a50e-24a85c0c238c

📥 Commits

Reviewing files that changed from the base of the PR and between 004cd02 and 75d7eb8.

📒 Files selected for processing (2)
  • docs/fern/components/InstallSelector.tsx
  • docs/fern/components/KubernetesContainerSelector.tsx

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

Both 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.

Changes

Version Label Consistency

Layer / File(s) Summary
Backend version display
docs/fern/components/InstallSelector.tsx, docs/fern/components/KubernetesContainerSelector.tsx
Version rows and chips now use the selected backend label and backend_version. Metadata uses the shared priority order and removes channel-specific “Dynamo nightly” display logic.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 75d7e

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)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change to lead nightly chips with the engine version.
Description check ✅ Passed The description includes all required sections, explains the changes and scope, identifies review files, and confirms no related issue.
Docstring Coverage ✅ Passed Docstring check was indeterminate for this PR — some files could not be analyzed in time. Not blocking.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant