Skip to content

docs(examples): fix broken markdown links in rollout_buffer and examples#2137

Open
CalvinXKY wants to merge 1 commit into
THUDM:mainfrom
CalvinXKY:docs/fix-broken-markdown-links
Open

docs(examples): fix broken markdown links in rollout_buffer and examples#2137
CalvinXKY wants to merge 1 commit into
THUDM:mainfrom
CalvinXKY:docs/fix-broken-markdown-links

Conversation

@CalvinXKY

@CalvinXKY CalvinXKY commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes several broken relative links in markdown docs.

The rollout_buffer README change addresses the same issue already fixed in the vime fork: vllm-project/vime#295. Both repos had links pointing at docs/{en,zh}/models/qwen3-4B.md, but the doc lives under docs/{en,zh}/examples/. vime is built on slime, not the other way around — this PR brings the equivalent fix back to slime and covers a few related broken links found in the same scan.

Changes

  • rollout_buffer README (EN/ZH): docs/{en,zh}/models/qwen3-4B.md -> docs/{en,zh}/examples/qwen3-4B.md
  • examples/README.md: point low_precision and reproducibility to docs/en/advanced/ pages (no matching example subdirectories exist)
  • examples/delta_weight_sync/README.md: remove embeds for PNG files that were never committed; keep the W&B metric names as text instead

Verification

  • Scanned repo markdown for broken relative links -> 0 remaining
  • pre-commit run --all-files passed locally
  • Docs-only change; no code paths affected

rollout_buffer README: point Qwen3-4B setup links to docs/{en,zh}/examples/ instead of non-existent docs/{en,zh}/models/

examples/README: link low_precision and reproducibility to the advanced docs pages (no matching example subdirectories exist)

delta_weight_sync README: replace missing W&B plot embeds with metric names; the PNG assets were never committed since THUDM#1806

Signed-off-by: kaiyuan <kyxiezju@163.com>
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.

1 participant