Skip to content

Align verl OPD documentation with runtime truth - #76

Merged
DaoyuanLi2816 merged 3 commits into
mainfrom
v0.9.1-docs-truth
Aug 14, 2026
Merged

Align verl OPD documentation with runtime truth#76
DaoyuanLi2816 merged 3 commits into
mainfrom
v0.9.1-docs-truth

Conversation

@DaoyuanLi2816

Copy link
Copy Markdown
Owner

Summary

  • correct the pip-only CUDA onboarding command and explain what each extra installs
  • distinguish verl forward_kl_topk from miniVERL bucketed_topk_tail
  • replace the invalid QLoRA-plus-swap recommendation with legal placement combinations
  • split current local OPD runtime and scale-out docs from the legacy PPO/reward bridge
  • center the docs home on the v0.9 measured developer workload
  • reduce PROJECT_STATE to a current handoff and archive the full v0.1-v0.9 history
  • make GitHub issues Roadmap: preregister real external alignment benchmarks #39 and Roadmap: verl-user product workflow after v0.9 #64 the active roadmap

Why

The public docs still mixed v0.8 development language, the one-update smoke, legacy bridge semantics, and a placement combination the runtime rejects. The correction keeps product claims aligned with the merged semantic-contract repair.

Validation

  • mkdocs build --strict
  • repository Markdown/link check
  • Ruff and mypy
  • documentation/packaging contract tests: 6 passed
  • Playwright visual gate: 44 rendered SVG instances, 15 pages, four viewports
  • screenshots: 60 files at 1440x900, 1024x768, 820x1000, and 390x844
  • manual inspection: home desktop/mobile, current runtime mobile, current scale-out desktop
  • frozen calculator SHA-256 unchanged: 53fc1d4d5b7adee09618d77ad62d4086ba56b78569832d6fc7c3bcd5c2695bbc

@DaoyuanLi2816
DaoyuanLi2816 marked this pull request as ready for review August 14, 2026 05:10
@DaoyuanLi2816
DaoyuanLi2816 merged commit 729b364 into main Aug 14, 2026
16 checks passed
@DaoyuanLi2816 DaoyuanLi2816 mentioned this pull request Aug 14, 2026
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