docs: align documentation paths with site structure - #12373
Merged
Conversation
Contributor
Author
|
This comment is the migration aid for contributors rebasing documentation PRs after this folder restructure merges. After rebasing onto Updated July 31, 2026 to match the squashed PR head. It includes the AI Simulate/Spica page set, the new sidecar and standalone-router pages, Use Cases paths, the vanilla-vLLM on-ramp, and translated-page moves. The current navigation has 332 entries backed by 328 unique page files. The block contains 346 old-to-new path pairs, including 13 translated-page pairs. |
Jont828
temporarily deployed
to
external_collaborator
July 29, 2026 18:08 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
Jont828
temporarily deployed
to
external_collaborator
July 29, 2026 18:08 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
github-actions
Bot
added
external-contribution
Contributor
|
/ok to test 6fb4efb |
github-actions
Bot
added
docs
documentation
Jont828
temporarily deployed
to
external_collaborator
July 30, 2026 23:15 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Contributor
|
/ok to test 420bf2e |
Jont828
temporarily deployed
to
external_collaborator
July 30, 2026 23:37 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Contributor
|
/ok to test 4c960c1 |
Jont828
force-pushed
the
docs-folder-restructure
branch
from
July 30, 2026 23:51
4c960c1 to
404a05c
Compare
Jont828
temporarily deployed
to
external_collaborator
July 30, 2026 23:51 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Contributor
|
/ok to test 404a05c |
Signed-off-by: Jont828 <jt572@cornell.edu>
Jont828
force-pushed
the
docs-folder-restructure
branch
from
July 31, 2026 00:07
404a05c to
51933c2
Compare
Jont828
temporarily deployed
to
external_collaborator
July 31, 2026 00:07 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Contributor
|
/ok to test 51933c2 |
Contributor
Author
|
Docs link check was b/c of a change to Helm chart, can do that as follow up bc it requires approval from gms owners |
Change72
added a commit
to Change72/dynamo
that referenced
this pull request
Jul 31, 2026
ai-dynamo#12373 moved docs/fern/kubernetes/snapshot.md to docs/fern/pages/developer-guide/knowledge-base/kubernetes/kubernetes-operator/snapshot.md but left the link in the snapshot Helm chart README pointing at the old path, which the docs link check flags as broken. Point it at the new location. Signed-off-by: Change72 <changg@nvidia.com>
dagil-nvidia
added a commit
that referenced
this pull request
Jul 31, 2026
Three shared-ownership globs referenced paths that were moved (not deleted) by a0245de ("docs: align documentation paths with site structure", #12373). This PR's new hardened strict gate treats stale globs as blocking, so those three now fail the coverage/policy gate against current main. Pruning them would silently drop docs, agents, and backend-sglang co-ownership from content that is still live, which is exactly the accountability loss .github/codeowners/README.md warns against. Re-point each glob at its current path instead, preserving team assignments: - docs/fern/agents/ -> docs/fern/pages/use-cases/agents/ - docs/fern/backends/sglang/agents.md -> docs/fern/pages/developer-guide/knowledge-base/modular-components/backends/sglang/agents-on-sglang.md - docs/fern/digest/agentic-inference/ -> docs/fern/pages/blog/2026/agentic-harness-support.mdx docs/fern/pages/blog/2026/agentic-inference-optimizations.mdx The digest folder fans out: assign docs+agents co-ownership only to the two article files, not the sibling _assets/agentic-inference/ tree, since binary/asset files do not need docs+agents review. Regenerated CODEOWNERS via emit_codeowners.py; the base+shared column alignment shifts because the new sglang path is the longest glob, but the -w diff shows only the four expected content changes. Strict gate now exits 0. 137 codeowners tests pass. Coverage 100%. Signed-off-by: Dan Gil <dagil@nvidia.com>
dagil-nvidia
added a commit
that referenced
this pull request
Aug 1, 2026
[kv-routing] and [mm-vllm] have no remaining references on the page -- the multimodal citations moved to [mm-kv-routing] and the KV-routing citation went with the accordion. Both were kept by mistake when resolving the rebase against the #12373 path rename, which carried HEAD's full definition list rather than the narrower set this commit intends. Signed-off-by: Dan Gil <dagil@nvidia.com>
dagil-nvidia
added a commit
that referenced
this pull request
Aug 1, 2026
…ave it The support-matrix accordion told readers that the notes below it cover the toolkit support of every platform preview and model-specific build the matrix excludes. They do not. CUDA_NOTES names v1.1.0-dev.* and v1.2.0-deepseek-v4-dev.3; RELEASES also carries v1.3.0-dev.1 and v1.2.0-deepseek-v4-dev.2, and neither has a note or a CUDA_HISTORY row. A reader on one of those two was sent to information that is not there. No CUDA version is recorded for either build anywhere in the repo -- not in releases.data.ts, not in model-early-access-builds, not in the generated inventory -- so documenting them would mean inventing toolkit requirements rather than reporting them. The caption is narrowed instead: it now promises coverage for the builds a note actually names and continues to point at the machine-readable inventory for the rest. The comment on SUPPORT_MATRIX_KINDS records which builds are uncovered and why the wording is hedged, so the next person to add a note knows what the gap is. Validation: gen_llms_tables.py --check reports all seven outputs unchanged after regeneration (compatibility.mdx is the only one that moved, by the one caption sentence). fern check is 0 errors / 1292 warnings, the baseline. check_reference.sh gates 1, 2, 3 and 5 pass, including fern broken-links at 0 site errors; gate 4 raises StopIteration on main as well, from #12373 removing the nav variants layer, and is untouched here. Signed-off-by: Dan Gil <dagil@nvidia.com>
This was referenced Aug 2, 2026
dagil-nvidia
added a commit
that referenced
this pull request
Aug 2, 2026
Relocates the Proposals tab onto main's post-restructure docs layout (#10855 fern/ -> docs/fern/, #12373 page renames): - docs/proposals/*.mdx -> docs/fern/pages/proposals/*.mdx - fern/components/Dep*.tsx -> docs/fern/components/ - fern/js/dep-*.js -> docs/fern/js/ - fern/scripts/sync_deps.py -> docs/fern/scripts/ - fern/docs.yml js: entries -> docs/fern/docs.yml - docs/index.yml proposals tab-> docs/fern/index.yml - docs/fern/main.css: kept both sides (main's Community/Mermaid blocks and the DEP status-pill block) Path constants, fixtures, workflow steps and .gitignore follow the move. The generated dir is now docs/fern/pages/proposals/_generated/, which sits under docs/fern/pages/ so the docs-website rsync picks it up. Signed-off-by: Dan Gil <dagil@nvidia.com>
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>
jh-nv
added a commit
that referenced
this pull request
Aug 12, 2026
The launch script this entry links to is added by this PR, so the blob/main URL 404s until the PR merges and lychee fails on it. The repository already sequences these separately: agg_embed.sh landed in #9713 and its examples-page entry followed in #12373 once the file existed on main. Reverts only the docs hunk; the pooling rank validation stays. Signed-off-by: Jie Hao <jihao@nvidia.com>
jh-nv
added a commit
that referenced
this pull request
Aug 12, 2026
The launch script this entry links to is added by this PR, so the blob/main URL 404s until the PR merges and lychee fails on it. The repository already sequences these separately: agg_embed.sh landed in #9713 and its examples-page entry followed in #12373 once the file existed on main. Reverts only the docs hunk; the pooling rank validation stays. Signed-off-by: Jie Hao <jihao@nvidia.com>
16 tasks
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
Reorganize the Fern documentation sources so their filesystem paths mirror the site navigation and use predictable kebab-case names.
Summary
kubernetes/,cli/,features/,developer-guide/, andreference/.overview.mdxand labeling them Overview.Details
The source tree now follows the major Fern tabs and sections instead of accumulating pages in legacy top-level buckets. This makes a page's location inferable from its tab, section, and sidebar title while keeping navigation presentation controlled by
docs/fern/index.yml.For contributors with open PRs, see the Old-to-new file mapping for rebasing comment on this PR. It lists the previous and new paths for every moved published page, including translated pages.
Where should the reviewer start?
docs/fern/index.ymlfor the reorganized navigation paths.docs/fern/docs.ymlfor URL continuity redirects..github/filters.yaml,.github/workflows/fern-docs.yml, and.github/codeowners/areas.yamlfor repository automation updates.Validation
fern check— 0 errorsfern docs broken-links— all checks passedgit diff --check— passedRelated Issues
🚫 This PR is NOT linked to an issue: