docs: reorganize use cases navigation - #12410
Merged
Merged
Conversation
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
github-actions
Bot
added
docs
documentation
Contributor
WalkthroughAdds an interactive Kubernetes container selector, integrates it into the quickstart, and updates documentation navigation, contribution placement, and redirects. ChangesKubernetes quickstart selector
Documentation information architecture
Estimated code review effort: 3 (Moderate) | ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/fern/components/KubernetesContainerSelector.tsx`:
- Around line 65-100: Update commandFor and its caller to require a
user-provided registry/namespace before generating custom-image commands, and
use that value when constructing XPU_IMAGE and RUNTIME_IMAGE instead of the
hardcoded registry.example.com placeholder. Ensure the selector collects or
validates this input before allowing either custom build path to be copied.
- Around line 169-174: Update copyCommand to catch navigator.clipboard.writeText
failures and set a retryable failure label/state when copying is denied or
fails. Preserve the existing successful “Copied!” label and reset behavior, and
ensure missing clipboard support also surfaces the same failure state instead of
returning silently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 92df2614-8f85-42b3-b6a1-45568dd94dbe
📒 Files selected for processing (4)
docs/fern/components/KubernetesContainerSelector.tsxdocs/fern/docs.ymldocs/fern/index.ymldocs/fern/kubernetes/quickstart.mdx
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![dynamo-review-agent[bot]](https://avatars.githubusercontent.com/u/201626793?s=60&v=4){kind=small}
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Contributor
Author
|
/ok to test 68f5ab4 |
Contributor
athreesh
enabled auto-merge (squash)
July 30, 2026 14:33
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
athreesh
force-pushed
the
docs/use-cases-nav-reorg
branch
from
July 30, 2026 14:34
8cb2b84 to
0fab5fe
Compare
Contributor
Author
|
/ok to test 0fab5fe |
dagil-nvidia
approved these changes
Jul 30, 2026
akshatha-k
reviewed
Jul 30, 2026
| path: kubernetes/inference-gateway.mdx | ||
| - page: Standalone Router | ||
| slug: standalone-router | ||
| path: components/router/router-guide.md |
Contributor
There was a problem hiding this comment.
standalone router redirects to old router guide- Need to convert https://github.com/ai-dynamo/dynamo/tree/main/components/src/dynamo/router/ into a fern doc
| - page: Disaggregated Serving | ||
| - page: Standalone Router | ||
| slug: standalone-router | ||
| path: components/router/router-guide.md |
| return [ | ||
| `export DYNAMO_VERSION=${CURRENT_TAG}`, | ||
| 'export PLANNER_IMAGE="nvcr.io/nvidia/ai-dynamo/dynamo-planner:${DYNAMO_VERSION}"', | ||
| ].join("\n"); |
Contributor
There was a problem hiding this comment.
Planner image referenced but since it is a quickstart the 'Planner' hasn't been introduced and can be confusing why it's not just a dynamo container
| } | ||
|
|
||
| function commandFor(hardware: Hardware, registry: string): string { | ||
| if (hardware === "intel") { |
Contributor
There was a problem hiding this comment.
contains a non-clickable 'add registry' button on the right side of the intel custom DGD image.
since there's a text box to input registry/namespace- can perhaps put 'How to add registry' for the custom docker build instructions
1 task
dagil-nvidia
added a commit
that referenced
this pull request
Aug 3, 2026
The Reference tab's General group is shared across versions: release
snapshots keep its nav on ../pages-dev/ so every version dropdown renders
the always-current reference. Both the workflow and the composition
harness found that group with
.navigation[] | select(.tab == "reference")
| .variants[] | select(.title == "General")
#12410 deliberately flattened the Reference tab into folded sections with
no variant selector. The selector has matched nothing since 2026-07-30 --
verified against docs-website, where dev.yml carried `title: General` on
07-27 through 07-29 and lost it on 07-30. Shared Reference has been off
ever since, and would have frozen a per-version reference copy at the next
tag cut. Nothing failed, because the only guard was a ::warning:: that
fires during a tag cut where nobody reads it.
Key the group on where its content lives instead. #12373 moved those pages
to pages/reference/general/ and gave every other former variant its own
directory, so the split the variants expressed in the nav is now expressed
by directory -- a signal IA work does not rename in passing. The Reference
tab's flattening is preserved; only the machinery moves.
The snapshot drop and the version-config revert become plain path
operations, which also removes a live defect: a yq assignment whose
left-hand side traverses a missing key auto-creates it, so the dead
`.variants[]` selector injected an empty `variants: []` into the composed
dev.yml and <TAG>.yml. That invalidates the whole navigation against
Fern's schema -- reported confusingly as a bad object at
$.navigation[4].layout[3], several hundred lines from the injection.
That is the Docs Website Composition Check failure on this PR, and the
same unguarded assignment in the release-version job would have corrupted
the next tag's version file.
Both silent-skip paths in the workflow become hard failures, and the
harness gains assertion 9 asserting the group is findable at all, so the
next rename fails on the PR that causes it rather than six days later.
Assertion 4 also stops false-passing: its find target no longer exists, so
find errored and wc counted zero while the assertion reported ok.
Validation:
DOCS_WEBSITE_REF=origin/docs-website \
bash docs/fern/scripts/simulate_docs_website.sh
9. dev.yml exposes a shared Reference group (7 entries) ok
2. v9.9.9.yml: reference/general shared (13 pages-dev refs) ok
2. v9.9.9.yml: Components section frozen (runtime configuration) ok
3. snapshot drops shared files, keeps versioned reference/ ok
5. pre-rework versions gain no shared-reference pointers ok
6. round-two propagation reaches the cut version's nav ok
7. converter moved to fern/scripts/ with no stale root copy ok
8. translated links resolve to dev and tag-pinned site URLs ok
1. fern check on composed tree (0 errors) ok
ALL ASSERTIONS PASSED
Was four FAILs (2, 3, 6 and fern check) before this change. Negative test:
renaming pages/reference/general/ to reference/core/ fails assertion 9 with
exit 1 while fern check stays at 0 errors, confirming a non-matching
selector no longer corrupts the tree. Composed dev.yml and v9.9.9.yml carry
no variants key. bash -n passes on all 33 run blocks in fern-docs.yml.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Dan Gil <dagil@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview:
Reorganizes the Dynamo docs IA around separate Kubernetes and CLI guide tabs, a renamed Use Cases tab, and a flattened Reference tab without a selector.
Details:
Where should the reviewer start?
Start with
docs/fern/index.ymlfor the navigation model, thendocs/fern/kubernetes/quickstart.mdxanddocs/fern/components/KubernetesContainerSelector.tsxfor the quickstart widget.Related Issues
🚫 This PR is NOT linked to an issue:
Validation
npx --yes fern-api@5.80.2 check --warnings(0 errors; existing unauthenticated redirects check skip and accent contrast warning)npx --yes fern-api@5.80.2 docs broken-linksnpx --yes esbuild docs/fern/components/KubernetesContainerSelector.tsx --bundle --platform=browser --external:react --external:./releases.data --external:./local-selector-styles --outfile=/tmp/kubernetes-container-selector.jsgit diff --check