Skip to content

docs: backport main docs tree and docs CI to release/1.4.0 - #12950

Merged
dagil-nvidia merged 8 commits into
release/1.4.0from
dagil/docs-backport-1.4.0
Aug 15, 2026
Merged

dagil-nvidia merged 8 commits into
release/1.4.0from
dagil/docs-backport-1.4.0

Conversation

@dagil-nvidia

@dagil-nvidia dagil-nvidia commented Aug 10, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Backports all docs changes from main to release/1.4.0 ahead of the v1.4.0 tag, promotes v1.4.0 to current release across the docs values, and prunes every documented feature that is not shipped in 1.4.0.

Snapshot + ledger (refreshed 2026-08-14):

v1.4.0 docs values:

  • releases.data.ts: current release → v1.4.0 / Aug 14, 2026, shipped pins (SGLang 0.5.16, TRT-LLM 1.3.0rc22, vLLM 0.26.0, NIXL 1.3.0/1.3.1/1.3.2, UCX 1.21.x from container/context.yaml), CUDA rows, artifact tags; regenerated outputs. Wheel confirmed plain 1.4.0.
  • Copy-paste surfaces → 1.4.0 (install guides EN/zh-CN, quickstarts, READMEs, profiler guide, guide examples). Recipes pins deliberately untouched.
  • Note: the Reference General pages render from pages-dev (main) on the live site — the live promotion is #13269 (merge with the tag); this branch's copies keep the tree consistent.

Unshipped-feature prune (systematic): every main commit touching docs since the cut (65 non-docs-typed) was audited; each PR was verified against release code by cherry-pick reference AND code symbols before any removal. Removed or reverted to release-true wording: TCP-plane TLS (#10921/#12533), custom worker-selection policies (#12526/#12536/#12992/#12720/#12897/#13008/#13155), planner power caps (#12012) and runtime min-endpoints (#13038), AIC-core wheel (#12454), request-trace S3 sink (#11806/#13002), SGLang engine method routes (#12246), Mooncake KV indexing (#11239) and DCP block size (#12765), OTLP log-format split (#12424), stalled-worker migration (#11647), SSE keep-alive (#12453), basetenkenizer (#12376) + tokenizer fallback (#12923) + tokenizers 1.8 (#12707), EPP metrics (#11868/#11981), conversation-affinity rank source (#12225, base feature kept), non-max-overlap metrics (#12585), single-pod Ray head (#12943), Codex thread/compaction headers (#12331/#13012), agent classification (#12787), snapshot PodReference.Containers (#12068), CRD v1beta1 storage (#11904), grove.forceScalingGroup (#11772), runtime-version hashing (#12633), DGDR path normalization (#12493), token-overflow admission (#12092), over-context rejection (#12092), FastVideo typed API (#9591, page transplanted from the release source), and the Spica→Sweeper rename (#12446, Spica docs+nav restored). Deployment-level thinking defaults (#11047) were verified PRESENT in release and kept.

Generated references now build from this branch's code: Python, Rust, and Kubernetes API pages regenerated (operator generate-api-docs path fix synced from main; release-side Go doc-comment example tags bumped to 1.4.0, mirroring #13270 on main). All repo-side markdown links repointed at the restructured docs tree (113 broken → 0). .lycheeignore gains two remove-after-tag entries for the pre-existence 404s (releases/tag/v1.4.0, docs.rs/*/1.4.0).

Validation

  • Absent-feature symbol sweep across docs (30+ markers): 0 hits outside shared reference/general.
  • detect_broken_links.py repo-wide: 0 broken links, 540 files.
  • Nav check: every index.yml path exists; no dangling entries for removed pages.
  • gen_llms_tables.py --check, gen_python_api.py --check, gen_rust_api.py --check: all unchanged; make generate-api-docs stable.
  • pre-commit on the changed set: clean.

🤖 Generated with Claude Code

@dagil-nvidia
dagil-nvidia requested review from a team as code owners August 10, 2026 17:41
@github-actions github-actions Bot added docs documentation Improvements or additions to documentation actions labels Aug 10, 2026
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 2a92c9b

@github-actions

github-actions Bot commented Aug 10, 2026 •

Copy link
Copy Markdown
Contributor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

<ParamField path="--decode-fallback / --no-decode-fallback" type="boolean" default="false">
Fall back to aggregated mode when prefill workers are unavailable.
Environment variable: `DYN_DECODE_FALLBACK`

P2 Badge Remove the unavailable decode-fallback flag

The v1.4.0 frontend parser does not define --decode-fallback or DYN_DECODE_FALLBACK; it only accepts the older --enforce-disagg compatibility option, which is deprecated and ignored. A user following this reference therefore gets an unrecognized-argument startup failure instead of enabling aggregated fallback when prefill workers disappear. Retain the release's actual flag surface or backport the fallback implementation before documenting this option.


### Enabling Session Control
Session control is request-driven. The `StickySessionRouter` activates automatically when a request carries `nvext.session_control` -- no additional frontend flags are needed beyond `--router-mode kv`. Use `action: "bind"` for router-only sticky routing without calling SGLang. On the worker side, streaming sessions must be explicitly enabled only for `action: "open"` / `action: "close"` lifecycle RPCs and session KV isolation.

P2 Badge Remove the unsupported SGLang session-control workflow

The v1.4.0 request schema and KV router contain no nvext.session_control handling or StickySessionRouter lifecycle actions. Requests copied from this example therefore do not open, bind, or close the documented SGLang session, so later turns are not pinned by this field and the claimed KV isolation and deterministic cleanup never occur. Version-gate this workflow or backport the session-control protocol and router integration.

ℹ️ 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".

Comment on lines +59 to +62
```bash
export DYN_REQUEST_TRACE=1
export DYN_REQUEST_TRACE_SINKS=s3
export DYN_REQUEST_TRACE_S3_BUCKET=my-org-request-traces

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Remove the unavailable S3 trace sink from the 1.4 docs

On the v1.4.0 release code, lib/llm/src/request_trace/config.rs defines only File, Stderr, Nats, and Otel, and parse_sink_kind_names treats s3 as an unknown sink and ignores it. A user following this command can therefore run with no active trace sink and silently produce no S3 objects, losing the request traces they expected to collect. Version-gate this section or backport the S3 implementation and Cargo feature before publishing these pages as v1.4.0.

Useful? React with 👍 / 👎.

Comment on lines +77 to +81
```json
{
"enable_power_awareness": true,
"total_gpu_power_limit": 5200
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Remove the unavailable power-aware Planner config

In the v1.4.0 release code, PlannerConfig has neither of these fields and Pydantic's default extra-field behavior silently discards them. Consequently, a deployment copied from this section starts without power-aware scaling and can scale past the documented total_gpu_power_limit, even though the operator believes the budget is active. This section should be omitted from the 1.4 snapshot unless the corresponding Planner implementation is backported.

Useful? React with 👍 / 👎.

Comment on lines +42 to +44
| CLI Argument | Env Var | Valid values | Default |
|---|---|---|---|
| `--tokenizer` | `DYN_TOKENIZER` | `default`, `fastokens`, `basetenkenizer` | `default` |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove basetenkenizer from the 1.4 valid-value list

For the v1.4.0 code being documented, components/src/dynamo/frontend/frontend_args.py restricts tokenizer backends to default and fastokens, while the Rust parser likewise rejects every other value. Thus python -m dynamo.frontend --tokenizer basetenkenizer from this page fails validation instead of selecting the advertised backend. Keep this value in dev-only documentation or backport its implementation before including it in the release snapshot.

Useful? React with 👍 / 👎.

Comment on lines +110 to +114
- name: DYN_TCP_TLS_CERT_PATH
value: /etc/certs/server/cert.pem
- name: DYN_TCP_TLS_KEY_PATH
value: /etc/certs/server/key.pem
- name: DYN_TCP_TLS_CA_CERT_PATH

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Remove the unavailable TCP TLS configuration

The v1.4.0 runtime has no DYN_TCP_TLS_* handling or TLS upgrade for the TCP call-home transport; its existing frontend TLS flags protect the HTTP listener only. Because arbitrary environment variables do not cause startup validation, a Kubernetes deployment copied from this example starts successfully while frontend-worker traffic remains plaintext, contrary to the page's security guarantee. Version-gate this page or backport the TCP TLS implementation before publishing it with v1.4.0.

Useful? React with 👍 / 👎.

| `--video-generation-worker` | `DYN_SGL_VIDEO_GENERATION_WORKER` | `false` | Run as [video generation](../../../../../use-cases/diffusion/workflows/text-to-video.md#sglang) worker |
| `--disagg-config` | `DYN_SGL_DISAGG_CONFIG` | `None` | Path to YAML disaggregation config file |
| `--disagg-config-key` | `DYN_SGL_DISAGG_CONFIG_KEY` | `None` | Key to select from disaggregation config (e.g., `prefill`, `decode`) |
| `--engine-route` | `DYN_SGLANG_ENGINE_ROUTES` | `None` | Expose a startup-allowlisted SGLang Engine or tokenizer-manager method under `/engine/<path>`; repeat the flag or separate environment descriptors with whitespace |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove the unavailable configurable SGLang engine routes

The v1.4.0 SGLang argument parser has no --engine-route option or DYN_SGLANG_ENGINE_ROUTES processing. Starting a worker with the documented flag therefore fails as an unrecognized argument, while using the environment variable silently exposes no additional route; the fixed /engine/control/* registrations in this release do not implement this configurable method allowlist. Keep this entry in dev-only docs unless the route parser and registration logic are backported.

Useful? React with 👍 / 👎.

Comment on lines +2616 to +2618
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `forceScalingGroup` _boolean_ | forceScalingGroup opts a single-node component into rendering as a<br />PodCliqueScalingGroup with one single-pod PodClique per replica.<br />Scaling changes the scaling-group replica count. The first<br />`minAvailable` replicas join the deployment's base PodGang together<br />with its other base workloads; each replica beyond `minAvailable`<br />gets its own PodGang, gang-scheduled separately from the rest of the<br />deployment. `false` or omitted means automatic selection (multi-node<br />and inter-pod GMS components use a scaling group, other single-node<br />components a standalone PodClique), not "force PodClique".<br />Immutable after creation. | | Optional: \{\} <br /> |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove forceScalingGroup from the 1.4 CRD reference

The v1.4.0 DynamoGraphDeployment Go types and installed CRD schema contain no GroveSpec or forceScalingGroup field. A manifest authored from this table is therefore rejected under strict server-side field validation or has the unknown field pruned, after which the operator uses its normal automatic PodClique/PodCliqueScalingGroup choice instead of the requested topology. Generate the release API reference from the release CRDs or omit this post-release field.

Useful? React with 👍 / 👎.

@datadog-official

This comment has been minimized.

Re-snapshot docs/ from main (46 further commits since the first snapshot),
re-apply the release ledger at the new paths - the 1.4.0 image-tag pins,
the shipped-behavior reference sync (#12983), the CKF metric caveats
(#13149), and the UCX/EFA facts (#13049) - and sync docs CI plus both
READMEs from main so no link targets the deleted old layout.

Promote v1.4.0 to current release across the docs values: releases.data.ts
(CURRENT_* consts, v1.4.0 release entry with shipped pins SGLang 0.5.16 /
TRT-LLM 1.3.0rc22 / vLLM 0.26.0 / NIXL 1.3.0-1.3.2 / UCX 1.21.x, CUDA rows,
artifact tags) with regenerated reference pages, and bump copy-paste
container tags in install guides (EN/zh-CN), READMEs, profiler and guide
examples. Recipe-mirroring pages keep their deliberate validation pins.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia force-pushed the dagil/docs-backport-1.4.0 branch from 2a92c9b to 590f831 Compare August 14, 2026 17:31
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 590f831

…h 1.4.0

Audit every main commit that touched docs since the branch cut (65
non-docs-typed commits, each PR verified against release code by
cherry-pick reference and code symbols) and remove documentation for the
features absent from release/1.4.0: TCP-plane TLS, custom worker-selection
policies (scorer/picker/filters/catalog), planner power caps and
runtime-configurable minimum endpoints, AIC-core wheel dependency,
request-trace S3 sink, SGLang engine method routes, Mooncake KV event
indexing, DCP-aware KV event block size, OTLP/console log-format split,
stalled-worker migration semantics, SSE keep-alive, basetenkenizer and
tokenizer-fallback, EPP metrics and cached_tokens, conversation-affinity
rank source, non-max-overlap metrics, single-pod Ray head, Codex
thread/compaction headers, agent-request classification, snapshot
PodReference.Containers, CRD v1beta1 storage, grove.forceScalingGroup,
runtime-version rollout hashing, dynamo-tokenizers 1.8 features, the
FastVideo typed-API rewrite, and the Spica-to-Sweeper rename (Spica docs
restored). Deployment-level thinking defaults were verified present in
release and kept.

Regenerate the Python, Rust, and Kubernetes API references from this
branch's code (also fixing the operator generate-api-docs path for the
new docs layout, synced from main), repoint every repo-side markdown link
at the restructured docs tree (113 broken links to 0), and scope lychee
for the pre-tag v1.4.0 release and docs.rs URLs with remove-after notes.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia requested review from a team as code owners August 14, 2026 19:29
@dagil-nvidia
dagil-nvidia requested review from a team as code owners August 14, 2026 19:29
@github-actions github-actions Bot added backend::vllm Relates to the vllm backend deployment::k8s Relates to dynamo deployment in kubernetes backend::sglang Relates to the sglang backend backend::trtllm Relates to the trtllm backend planner frontend `python -m dynamo.frontend` and `dynamo-run in=http|text|grpc` router Relates to routing, KV-aware routing, etc. labels Aug 14, 2026
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 03a9664

… tags

Quality-gate fixes on the backport: the operator Makefile sync from main
had removed the release branch's test-e2e-dgdr machinery — restore the
release Makefile and splice in only the generate-api-docs target for the
new docs layout. Refresh the DGDR CRD YAML example strings to match the
updated Go doc comments so the operator tree is internally consistent,
and separate the two scoped .lycheeignore blocks.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 9009e60

…rence, recipe ID fix

Fix the helm-docs source template's docs link (the generated README was
fixed but generate-helm-docs regenerated the old link, dirtying the
operator check). Adopt main's refreshed vLLM benchmark sampling-flag
reference (#13036 — same shipped flag set, code-verified prose) and the
Qwen3.8 recipe model-ID correction (#13265). Triaged all main docs
commits since the last snapshot point: #13192 and #11723 docs excluded
(features absent from 1.4.0); release-side #13280/#13256 have no docs
impact (AIC-core wheel is a Spica dependency; planner shim wording
verified still correct).

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 00527fa

Same review catches as the main-side promotion: bare version variables
(gateway guides at 1.3.0, TRT-LLM overview example at 1.0.2) are invisible
to image-tag sweeps; bump them to 1.4.0.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 5f86be9

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test d3a8dff

…s inventory

dynamo-protocols (5.0.1), dynamo-parsers (7.0.1), and dynamo-tokenizers
(1.5.4) are registry dependencies on their own version lines, not
workspace crates on the Dynamo train; the blanket 1.4.0 bump would have
recommended versions this release neither builds nor publishes. Values
are the release/1.4.0 Cargo.toml pins; generated inventories rebuilt.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test d17b2ce

The directional docs.rs invariant (no crate ahead of the release tag)
only holds for crates released on the Dynamo train; off-train registry
dependencies like dynamo-parsers 7.x publish their own versions. Scope
the check by member_path, which the discovery layer already sets.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 0021c69

@dagil-nvidia
dagil-nvidia merged commit 7694107 into release/1.4.0 Aug 15, 2026
101 of 104 checks passed
@dagil-nvidia
dagil-nvidia deleted the dagil/docs-backport-1.4.0 branch August 15, 2026 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

actions backend::sglang Relates to the sglang backend backend::trtllm Relates to the trtllm backend backend::vllm Relates to the vllm backend deployment::k8s Relates to dynamo deployment in kubernetes docs documentation Improvements or additions to documentation frontend `python -m dynamo.frontend` and `dynamo-run in=http|text|grpc` planner router Relates to routing, KV-aware routing, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants