Skip to content

docs: address Dynamo docs nav and RL feedback - #12436

Merged
athreesh merged 19 commits into
mainfrom
docs/k8s-standalone-router-nav
Aug 5, 2026
Merged

docs: address Dynamo docs nav and RL feedback#12436
athreesh merged 19 commits into
mainfrom
docs/k8s-standalone-router-nav

Conversation

@athreesh

@athreesh athreesh commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • reorganize docs navigation for K8s/CLI guide updates, including Operations ordering and GAIE naming
  • clarify fault tolerance overview around request-level and worker-level behavior
  • update RL docs for engineers using Dynamo rollouts and add framework integration pointers
  • fix model deployment intro card link and keep Observability in Operations

Validation

  • git diff --check
  • fern docs broken-links
  • fern check --warnings (existing auth/contrast warnings only)

@athreesh
athreesh requested a review from a team as a code owner July 30, 2026 18:07
@copy-pr-bot

copy-pr-bot Bot commented Jul 30, 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 Jul 30, 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 found 1 potential issue.

Open in Devin Review

Comment thread docs/fern/docs.yml
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The standalone router page is removed from the Kubernetes Guide navigation, and its URL now redirects to the KV-aware routing overview.

Changes

Documentation routing

Layer / File(s) Summary
Retire standalone router navigation entry
docs/fern/index.yml, docs/fern/docs.yml
Removes the Standalone Router entry from KV-Aware Routing navigation and redirects its former path to the overview page.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains changes and validation but omits the required Related Issues section and the Where should the reviewer start section. Add the required Related Issues section and confirm whether the PR links to an issue; also identify the files or sections where reviewers should start.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title identifies a documentation navigation change but also mentions RL feedback that is not supported by the summarized changes.

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

@athreesh athreesh changed the title docs: keep standalone router out of k8s nav docs: fix standalone router nav and home links Jul 30, 2026
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@athreesh
athreesh force-pushed the docs/k8s-standalone-router-nav branch from 5d33e5a to a7873f1 Compare August 3, 2026 17:59
@athreesh athreesh changed the title docs: fix standalone router nav and home links docs: fix k8s nav and home links Aug 3, 2026
@datadog-official

This comment has been minimized.

@pull-request-size pull-request-size Bot added size/L and removed size/S labels Aug 4, 2026
@athreesh athreesh changed the title docs: fix k8s nav and home links docs: address Dynamo docs nav and RL feedback Aug 4, 2026
@athreesh
athreesh marked this pull request as draft August 4, 2026 17:10
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@athreesh
athreesh force-pushed the docs/k8s-standalone-router-nav branch from 93219ba to 4c44942 Compare August 4, 2026 17:10
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@pull-request-size pull-request-size Bot added size/XL and removed size/L labels Aug 4, 2026
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@athreesh

athreesh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

Pushed a Fern audit/fix pass in 4bd20f6a1d.

What changed:

  • Fixed dead/stale anchors across release artifacts, nightly info, observability, routing, vLLM/TRT-LLM, AIConfigurator, agents, multimodal, and release-note pages.
  • Tightened redirects for the Use Cases reorg, RL continuity URLs, DynoSim renamed routes, component reference pages, and model deployment intro URLs.
  • Fixed the stale overview/:slug* redirect behavior that could hijack canonical overview pages; validated the prior problematic agents/overview/session-i-ds style URLs.
  • Filled the Kubernetes model storage overview stub and cleaned up a few nav/title mismatches.

Local validation:

  • npx --yes fern-api@5.80.2 docs broken-links passes.
  • npx --yes fern-api@5.80.2 check --warnings has 0 errors; only existing warnings are unauthenticated missing-redirect audit and light-mode accent contrast.
  • git diff --check passes.
  • Targeted local smoke tests for canonical pages and reorg redirects returned 200s.

@athreesh
athreesh marked this pull request as ready for review August 4, 2026 23:10
@athreesh
athreesh enabled auto-merge (squash) August 4, 2026 23:12
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@athreesh

athreesh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test b35291d

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

@nv-tusharma

nv-tusharma commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

CI diagnosis — two independent failures:

  1. operator (make check) fails on a dirty tree, caused by this PR: docs/fern/pages/reference/kubernetes-api/additional-resources/api-reference-k8s.md is generated by make -C deploy/operator generate-api-docs, so the two hand-edits stripping the #endpointpickerconfig anchor get regenerated. Revert them, or fix the anchor at the source (deploy/operator/docs/crd-ref-docs-config.yaml / docs/fix-api-anchors.py) and commit the regenerated file.

  2. Operator Integration golden mismatch is not from this PR — it is branch staleness: this branch is 48 commits behind main, with a merge base predating fix(profiler): configure rapid mocker without planner #12573, which made --planner-profile-data conditional and regenerated deploy/operator/internal/controller/testdata/dgdr/*/output.yaml. Merging main should clear it.

…outer-nav

Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@athreesh
athreesh requested a review from a team as a code owner August 5, 2026 00:45
@github-actions github-actions Bot added the deployment::k8s Relates to dynamo deployment in kubernetes label Aug 5, 2026
@athreesh

athreesh commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test bbc3c06

@harryskim harryskim 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.

LGTM

@athreesh
athreesh merged commit d2ea526 into main Aug 5, 2026
103 checks passed
@athreesh
athreesh deleted the docs/k8s-standalone-router-nav branch August 5, 2026 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deployment::k8s Relates to dynamo deployment in kubernetes docs documentation Improvements or additions to documentation size/XXL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants