Skip to content

fix(docs): repair the 15 broken links lychee reports on release/1.3.1 - #12641

Merged
dagil-nvidia merged 1 commit into
release/1.3.1from
lychee-131
Aug 4, 2026
Merged

fix(docs): repair the 15 broken links lychee reports on release/1.3.1#12641
dagil-nvidia merged 1 commit into
release/1.3.1from
lychee-131

Conversation

@dagil-nvidia

@dagil-nvidia dagil-nvidia commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

lychee fails on every PR against release/1.3.1. The 15 errors fall into three unrelated classes; all are fixed here, and every replacement URL was verified to return 200.

Class Hits Fix
Dead external link 7 communityinviter.com/apps/cloud-native/cncf 404s. Replaced with https://slack.cncf.io/
Links into main whose targets moved 5 Repointed at the release tree
Docs-site URL that never existed 2 docs.nvidia.com/dynamo/design-docs/disaggregated-serving 404s; the page is in-repo as disagg-serving.md

Detail

CNCF inviteCONTRIBUTING.md, docs/contribution-guide.md, docs/contribution-guide.zh-CN.md. The old invite URL is dead upstream; slack.cncf.io is the current entry point.

Moved doc links — the Fern migration restructured these paths on main, so release-branch files linking into main now 404. This is the same fix #12618 applies on release/1.4.0. All four targets were verified present on release/1.3.1 before repointing:

  • deploy/helm/charts/platform/templates/NOTES.txt -> docs/kubernetes/installation-guide.md
  • docs/benchmarks/qwen3-6-35b-feature-stack.mdx -> docs/benchmarks/embedding_cache.md
  • docs/benchmarks/qwen3-vl-embedding-cache.mdx -> docs/features/multimodal/multimodal-vllm.md#embedding-cache
  • docs/features/multimodal/multimodal-kv-routing.md -> examples/backends/trtllm/mm_router_worker/README.md (2 links)
  • recipes/qwen3-vl-30b/README.md -> docs/features/multimodal/multimodal-vllm.md#embedding-cache

Disaggregated serving — both README.md table links pointed at a docs-site path that has never resolved. The page exists in-repo as docs/design-docs/disagg-serving.md, so they now point there on the release tree.

Not addressed

A kubebuilder.io request timeout in docs/kubernetes/webhooks.md. That is a flake, not a broken link, and fixing it is not in scope.

Test plan

  • lychee passes on release/1.3.1

Open in Devin Review

lychee has been failing on every PR against release/1.3.1. The 15 errors fall
into three unrelated classes; all are fixed here and every replacement URL was
verified to return 200.

Dead external link (7 hits, 3 files):
  https://communityinviter.com/apps/cloud-native/cncf now 404s. Replaced with
  https://slack.cncf.io/ in CONTRIBUTING.md and both contribution guides,
  including the zh-CN twin.

Links into main whose targets moved in the Fern migration (5 hits, 5 files):
  Repointed at the release tree, the same fix #12618 applies on release/1.4.0.
  All four targets verified present on release/1.3.1:
    docs/kubernetes/installation-guide.md
    docs/benchmarks/embedding_cache.md
    docs/features/multimodal/multimodal-vllm.md
    examples/backends/trtllm/mm_router_worker/README.md

Docs-site URL that never existed (2 hits, README.md):
  https://docs.nvidia.com/dynamo/design-docs/disaggregated-serving 404s. The
  page is in-repo and named disagg-serving.md, so both table links now point at
  docs/design-docs/disagg-serving.md on the release tree.

Not addressed: a kubebuilder.io request timeout in docs/kubernetes/webhooks.md,
which is a flake rather than a broken link.

Signed-off-by: Dan Gil <dagil@nvidia.com>
@dagil-nvidia
dagil-nvidia requested review from a team as code owners August 4, 2026 17:58
@github-actions github-actions Bot added fix documentation Improvements or additions to documentation deployment::k8s Relates to dynamo deployment in kubernetes labels Aug 4, 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 2 potential issues.

Open in Devin Review

## Results

Full result tables are reproduced below from the [source study](https://github.com/ai-dynamo/dynamo/blob/main/docs/benchmarks/embedding_cache.md); the headline numbers:
Full result tables are reproduced below from the [source study](https://github.com/ai-dynamo/dynamo/blob/release/1.3.1/docs/benchmarks/embedding_cache.md); the headline numbers:

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.

🟡 Documentation pages link to other documentation pages with full web addresses instead of in-repo paths

Two documentation pages now point at other documentation pages through absolute github.com addresses pinned to a release branch (blob/release/1.3.1/docs/... at docs/benchmarks/qwen3-6-35b-feature-stack.mdx:28), instead of the required in-repo relative path, so readers get bounced out of the docs site and the links go stale as soon as the branch name changes.
Impact: Readers clicking these links leave the documentation site for raw files on GitHub, and the links will point at outdated content once the release branch moves on.

Style rule for links inside docs/

docs/AGENTS.md states: "Links: relative + extension within docs/; absolute github.com/ai-dynamo/dynamo URLs for targets outside docs/". Both changed links target files inside docs/:

  • docs/benchmarks/qwen3-6-35b-feature-stack.mdx:28docs/benchmarks/embedding_cache.md (should be ./embedding_cache.md)
  • docs/benchmarks/qwen3-vl-embedding-cache.mdx:97docs/features/multimodal/multimodal-vllm.md#embedding-cache (should be ../features/multimodal/multimodal-vllm.md#embedding-cache)

The rest of docs/ follows the relative convention (e.g. docs/benchmarks/benchmarking.md:107 uses ../kubernetes/installation-guide.md). The links in recipes/qwen3-vl-30b/README.md:51 and deploy/helm/charts/platform/templates/NOTES.txt:30 are outside docs/, so absolute URLs are correct there.

Suggested change
Full result tables are reproduced below from the [source study](https://github.com/ai-dynamo/dynamo/blob/release/1.3.1/docs/benchmarks/embedding_cache.md); the headline numbers:
Full result tables are reproduced below from the [source study](./embedding_cache.md); the headline numbers:
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread README.md
| | [SGLang](https://docs.nvidia.com/dynamo/backends/sg-lang) | [TensorRT-LLM](https://docs.nvidia.com/dynamo/backends/tensor-rt-llm) | [vLLM](https://docs.nvidia.com/dynamo/backends/v-llm) |
|---|:----:|:----------:|:--:|
| [**Disaggregated Serving**](https://docs.nvidia.com/dynamo/design-docs/disaggregated-serving) | ✅ | ✅ | ✅ |
| [**Disaggregated Serving**](https://github.com/ai-dynamo/dynamo/blob/release/1.3.1/docs/design-docs/disagg-serving.md) | ✅ | ✅ | ✅ |

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.

🔍 Feature-matrix row now leaves the docs site for a raw GitHub markdown file

Every other row in this table (and the Core Capabilities table at README.md:93-100) links to docs.nvidia.com/dynamo/.... Fern derives page slugs from the nav page: title, and docs/index.yml:482-483 declares page: Disaggregated Servingpath: design-docs/disagg-serving.md, which implies the docs-site slug is design-docs/disaggregated-serving — exactly the URL being removed here. Compare README.md:87 (design-docs/overall-architecture) whose file is design-docs/architecture.md, confirming the title-derived slug pattern. The 404 the PR observed may therefore be because the 1.3.1 docs version hasn't been published yet rather than because the URL 'never existed'. Worth confirming before permanently downgrading two prominent README links to raw GitHub markdown, which reads worse for users and pins them to a branch that will eventually be superseded.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

@dagil-nvidia
dagil-nvidia merged commit a49702e into release/1.3.1 Aug 4, 2026
80 of 89 checks passed
@dagil-nvidia
dagil-nvidia deleted the lychee-131 branch August 4, 2026 18:36
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 documentation Improvements or additions to documentation fix size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant