Skip to content

docs: fix dead links to plugin and offline READMEs breaking pages deploy - #1077

Open
curnane-lab wants to merge 2 commits into
sgl-project:mainfrom
curnane-lab:fix/docs-dead-links
Open

curnane-lab wants to merge 2 commits into
sgl-project:mainfrom
curnane-lab:fix/docs-dead-links

Conversation

@curnane-lab

@curnane-lab curnane-lab commented Nov 7, 2026 •

Copy link
Copy Markdown
Collaborator

Motivation

The capture PR series (#1064, #1065, #1066) linked to plugins/sglang-spec-capture/README.md and examples/offline/README.md with paths relative to docs/. VitePress only resolves links inside its srcDir (docs/), so those targets are dead links and the pages deploy fails. The latest failure is the #1066 push to main: Release Documentation reports exactly these 10 links.

PR Test on this pull request fails in unit-test with dubious ownership. That comes from #1066 and is fixed separately in #1078. This change is documentation only.

Modifications

Replace the 10 repo-relative links with absolute GitHub blob URLs on main, the same form already used for other files outside docs/ (configs, gate scripts):

  • plugins/sglang-spec-capture/README.md: the three disaggregated recipes, AMD, Ascend, and installation.
  • examples/offline/README.md: AMD, data preparation, DFlash2, and the Llama3 EAGLE3 offline example.

Related Issues

Follow-up to #1064, #1065, and #1066. No open issue. The unrelated unit-test failure is #1078.

Accuracy Test

Not applicable. Documentation links only.

Benchmark & Profiling

Not applicable. Documentation links only.

Checklist

The capture PR series linked to plugins/sglang-spec-capture/README.md and
examples/offline/README.md with repo-relative paths, which escape the
VitePress srcDir (docs/) and fail the build with 10 dead links. Use the
absolute GitHub blob URLs like the rest of the docs.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants