Skip to content

docs: fix Snapshot doc links broken by its docs restructure - #18490

Merged
krishung5 merged 1 commit into
ai-dynamo:mainfrom
HanFa:hanfa/fix-snapshot-doc-links
Nov 10, 2026
Merged

krishung5 merged 1 commit into
ai-dynamo:mainfrom
HanFa:hanfa/fix-snapshot-doc-links

Conversation

@HanFa

@HanFa HanFa commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Overview

ai-dynamo/snapshot#786 restructured Snapshot's docs on 2026-11-09 and removed its docs/operations/ directory. Three links on the Restore Workers with Dynamo Snapshot page point into it, so the Docs link check (lychee) fails on every pull request and on main. This PR points them at the pages that replaced them.

Key Changes

This is a docs-only change: three links on one page, with 0 core-logic lines.

Line Removed target New target What happened to the page
109 docs/operations/storage.md docs/operate/configure-storage.md Renamed
116 docs/operations/install.md docs/get-started/installation.md Folded into Installation
227 docs/operations/troubleshooting.md docs/troubleshooting/restores.md Split into four pages; this link is for a failed restore

Validation

Link Before After
Snapshot storage configuration 404 200
Snapshot installation 404 200
Snapshot troubleshooting 404 200

The status codes come from unauthenticated requests, as lychee sends them. The page's other two Snapshot links are unchanged and return 200: the README's #prerequisites heading still exists, and ai-dynamo/snapshot#456 resolves.

On this PR, the Docs link check passes: lychee reports 0 errors across 9,928 links (job).

On main, lychee reports only storage.md and troubleshooting.md. install.md is also 404, but the workflow most likely still holds an earlier result for it in .lycheecache. These three lines are the only links into docs/operations/ in the repository, and the page has no zh-CN translation.

Issues and Ongoing Work

Pull Request Checklist
  • I used Dynamo's /pr-checklist skill.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Snapshot storage, installation, and troubleshooting links to point to the current documentation pages.

ai-dynamo/snapshot#786 removed Snapshot's docs/operations/ directory, so
three links on the Restore Workers with Dynamo Snapshot page return 404
and the Docs link check fails on every pull request. Point them at the
pages that replaced them: storage.md was renamed to
operate/configure-storage.md, the install page was folded into
get-started/installation.md, and the troubleshooting page was split, so
the failed-restore link now goes to troubleshooting/restores.md.

Signed-off-by: Fang Han <fangh@nvidia.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@HanFa
HanFa requested a review from a team as a code owner November 10, 2026 00:06
@copy-pr-bot

copy-pr-bot Bot commented Nov 10, 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.

@HanFa
HanFa temporarily deployed to external_collaborator November 10, 2026 00:06 — with GitHub Actions Inactive
@HanFa
HanFa temporarily deployed to external_collaborator November 10, 2026 00:06 — with GitHub Actions Inactive
@github-actions

github-actions Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot added docs external-contribution Pull request is from an external contributor documentation Improvements or additions to documentation labels Nov 10, 2026
@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Snapshot documentation page now links to the current storage, installation, and troubleshooting pages.

Changes

Snapshot documentation links

Layer / File(s) Summary
Update Snapshot documentation links
docs/fern/pages/kubernetes/model-deployment/model-loading/snapshot.mdx
The storage and installation references use current documentation paths. The troubleshooting reference points to docs/troubleshooting/restores.md.

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

Severity of issue fixed: Medium

Merge Risk: Minimal · up to 58703

The change updates documentation links; no merge-blocking risk is identified.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title clearly identifies the change: fixing Snapshot documentation links broken by a documentation restructure.
Linked Issues check Passed Issue #18489 requires the three removed Snapshot documentation links to point to current pages and stop failing the Docs link check. The diff updates the storage, installation, and restore-troubleshoo…
Out of Scope Changes check Passed The diff changes only the three Snapshot documentation links covered by issue #18489. It contains no unrelated changes.
Description check Passed The description includes all required sections, explains the link changes, reports validation results, identifies the linked issue, and completes the checklist.
Full details: Linked Issues check

Explanation

Issue #18489 requires the three removed Snapshot documentation links to point to current pages and stop failing the Docs link check. The diff updates the storage, installation, and restore-troubleshooting URLs to the replacement paths named in the issue context. The PR reports that all three replacement URLs return 200.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 0afe0c5 and 58703a3.

Files selected for processing: 1

  • docs/fern/pages/kubernetes/model-deployment/model-loading/snapshot.mdx

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

kanishksingh01 added a commit to kanishksingh01/dynamo that referenced this pull request Nov 10, 2026
Apply the three-link correction from ai-dynamo#18490.
Refs ai-dynamo#18489.

Original-commit: 58703a3
Co-authored-by: Fang Han <fangh@nvidia.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Kanishk Singh <130019754+kanishksingh01@users.noreply.github.com>
@krishung5

Copy link
Copy Markdown
Contributor

/ok to test 58703a3

@krishung5
krishung5 enabled auto-merge (squash) November 10, 2026 06:10
@krishung5
krishung5 merged commit 72ca671 into ai-dynamo:main Nov 10, 2026
114 checks passed
ishandhanani added a commit to ishandhanani/dynamo that referenced this pull request Nov 10, 2026
Absorbs 2 upstream commits (3e1a20a, 72ca671). One conflict: lib/llm/src/kv_router/routing_host/hosted.rs, where upstream removed select_lora_target (it becomes LegacyLoraPolicy::select in the new lib/llm/src/lora_routing.rs) and the stack had changed one line inside it (.map_err(KvSchedulerError::from) on the hosted picker call, because dynamo_worker_selection's HostedWorkerPicker::select returns SelectionFailure where upstream's returns KvSchedulerError). Took upstream's removal; the map_err moves with the code into lora_routing.rs, matching the two remaining lib/llm picker call sites.

- ai-dynamo#17889 refactor(router) generic candidate policy hooks: lib/llm only. routing_policy.rs gains the crate-private HostedCandidatePolicy, KvAdmissionPolicy, CandidateSelection and AttemptLease; lora_routing.rs (new) holds LegacyLoraPolicy (hosted) and LegacyLoraAdmission (KV) with the load lease and two unit tests; RoutingHost's lora field becomes candidate_policy and RequestGuard's lora load guard becomes _attempt_lease; KvRouter's availability callback delegates to the admission policy; hosted_request becomes pub(crate) and is re-exported with hosted_picker from kv_router.rs; the routing_host test module gains failing and unfinished dispatch cases. The two new files import SchedulingRequest, ScheduleMode and KvSchedulerError from dynamo_scheduler::host, HostedWorkerPicker from dynamo_worker_selection::host and WorkerWithDpRank from dynamo_router_protocol::worker instead of the pre-split dynamo_kv_router paths. Both traits take lib/llm's PreprocessedRequest and RuntimeConfigWatch and stay private to lib/llm; no router crate, plugin surface or prelude change.
- ai-dynamo#18490 docs: fix Snapshot doc links broken by its docs restructure: one docs page; auto-merged.

No router-owned path changed; no [features] table or Dynamo path-crate dependency edge changed.

Signed-off-by: Ishan Dhanani <ishandhanani@gmail.com>

This branch was previously deployed

1 inactive deployment
external_collaborator — 58703a3f Deployed Nov 10, 2026 by HanFa via ok-to-test #48996
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 external-contribution Pull request is from an external contributor size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: Docs link check fails on Snapshot doc links removed by its docs restructure

3 participants