Skip to content

docs: point README disaggregated-serving links at a published page - #12369

Closed
dagil-nvidia wants to merge 3 commits into
mainfrom
dagil-nvidia/fix-readme-disagg-doc-link
Closed

docs: point README disaggregated-serving links at a published page#12369
dagil-nvidia wants to merge 3 commits into
mainfrom
dagil-nvidia/fix-readme-disagg-doc-link

Conversation

@dagil-nvidia

@dagil-nvidia dagil-nvidia commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

Overview

Both README links to the disaggregated-serving design doc 404. This points them at docs.nvidia.com/dynamo/dev/kubernetes/model-deployment/disaggregated-serving, which returns 200.

Root cause

docs/fern/docs.yml redirects /dynamo/design-docs/disaggregated-serving to /dynamo/dev/knowledge-base/design-documents/disaggregated-serving. Neither URL resolves — the whole /dynamo/dev/knowledge-base/... namespace is unpublished. /dynamo/design-docs/architecture-flow has the same broken redirect, while the older /dynamo/design-docs/overall-architecture still returns 200, so this is not limited to one page.

docs/fern/design-docs/disagg-serving.md also does not appear in the docs.yml nav, so it has no published URL of its own.

Why now

lychee fails on these links for every PR carrying current main, and dynamo-status-check aggregates it, so it blocks merges repo-wide on code-freeze day.

Follow-up

The unpublished knowledge-base namespace and the missing nav entry need a separate fix from the docs owners. This change only unblocks the link checker.

🤖 Generated with Claude Code

Both links pointed at docs.nvidia.com/dynamo/design-docs/disaggregated-serving,
which 404s and 308-redirects to the knowledge-base path. The link checker fails
on every PR as a result, blocking dynamo-status-check repo-wide.

Signed-off-by: Daniel Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia requested a review from a team as a code owner July 29, 2026 17:47
@copy-pr-bot

copy-pr-bot Bot commented Jul 29, 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.

@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

@github-actions github-actions Bot added the docs label Jul 29, 2026
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Two README capability-table links were updated from the previous design-docs location to the canonical dev/knowledge-base/design-documents path for disaggregated serving documentation.

Changes

README documentation links

Layer / File(s) Summary
Canonical documentation paths
README.md
The Disaggregated Serving and Disaggregated Prefill/Decode entries now use the updated documentation URL path.

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 PR description is informative, but it omits required template sections like Details, reviewer start, and Related Issues. Add the missing template sections, especially Details, Where should reviewer start?, and a completed Related Issues section.
✅ 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 clearly describes the README link update and matches the main change.

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 29, 2026
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test ee96c64

@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The design-docs/* redirects in docs/fern/docs.yml target a
/dynamo/dev/knowledge-base/... namespace that is not published yet, so both
the source and destination URLs 404 and lychee fails on every PR.
Point at the live deployment guide instead.

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

Copy link
Copy Markdown
Collaborator Author

/ok to test ee96c64

@copy-pr-bot

copy-pr-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

/ok to test ee96c64

@dagil-nvidia, there was an error processing your request: E2

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/2/

@rmccorm4
rmccorm4 enabled auto-merge (squash) July 29, 2026 20:22
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test a510dea

@dagil-nvidia dagil-nvidia changed the title docs: fix 404 disaggregated-serving links in README docs: point README disaggregated-serving links at a published page Jul 29, 2026
@dagil-nvidia

Copy link
Copy Markdown
Collaborator Author

Superseded by #10855, which repointed both README links as part of the docs tab-navigation restructure and published the knowledge-base namespace. docs.nvidia.com/dynamo/dev/knowledge-base/concepts/system-architecture/disaggregated-serving now returns 200, so this change is redundant and conflicts with main. Closing.

The remaining lychee failure has moved to docs/fern/getting-started/about.md and is tracked separately.

auto-merge was automatically disabled July 29, 2026 22:39

Pull request was closed

@dagil-nvidia
dagil-nvidia deleted the dagil-nvidia/fix-readme-disagg-doc-link branch July 29, 2026 22:39
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/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants