执行摘要
This PR updates the Ascend Quickstart documentation by renaming sections, updating table descriptions, and adding a link to the training configuration parameters guide. Two high-priority issues identified during review (a broken anchor link and a personal fork URL) were promptly fixed, resulting in a cleaner and more accurate documentation page.
功能与动机
动机是改进 Ascend Quickstart 文档的可读性和准确性,具体包括:
- 重命名章节使其更具体(
基础验证场景说明 → Qwen3-0.6B GSM8K GRPO Quick Start)
- 在表格前增加说明文字,帮助用户快速理解四种训推后端组合的用途
- 添加指向训练配置参数文档的链接,方便用户查阅详细参数说明
- 更新日期并添加指向 NPU 高级特性指南的链接
实现拆解
1. 更新第一个文件 docs/ascend_tutorial/get_start/quick_start.rst
- 重命名二级标题和目录条目
- 修改目录中的锚点链接(从
#基础验证场景说明 改为 #qwen3-06b-gsm8k-grpo-quick-start,后经 review 修正为 #qwen3-0-6b-gsm8k-grpo-quick-start)
- 在表格前添加一行描述文本
- 在表格后添加指向
parameter_and_metrics.md 的链接(初始指向个人 fork,后修正为官方仓库)
- 将小节标题
SGLang 后端通用说明 改为 SGLang 后端使能说明
2. 更新第二个文件 docs/ascend_tutorial/dev_guide/model_dev/parameter_and_metrics.md
- 将上次更新日期从
05/29/2026 改为 07/02/2026
- 添加一行指向
npu_advance_features.md 的链接
3. Review 修复
- 接受 reviewer 建议,将锚点链接修正为正确的 Sphinx 格式
- 将文档链接从个人 fork 修正为官方仓库
不适用,本 PR 仅涉及文档文本变更。
评论区精华
reviewer gemini-code-assist[bot] (high priority): The link points to a personal fork (yyyy2000/verl) instead of the main repository (verl-project/verl). Please update it to point to the official repository to ensure the link remains valid and accessible to all users.
reviewer gemini-code-assist[bot] (high priority): The anchor link #qwen3-06b-gsm8k-grpo-quick-start is broken because Docutils/Sphinx converts punctuation (like the dot in 0.6B) into a hyphen. The auto-generated anchor for Qwen3-0.6B GSM8K GRPO Quick Start is #qwen3-0-6b-gsm8k-grpo-quick-start. Please update the anchor link to ensure proper navigation.
两位高优先级问题均由机器人 reviewer 指出,作者通过后续 commit 修复,最终由 wucong25 批准合并。
风险与影响
风险极低,仅涉及文档文本更新,无任何代码或配置变更。影响范围限于 Ascend 用户阅读 Quickstart 文档时的导航性和可读性提升。
关联脉络
本 PR 是对 PR #6900 的补充修复。#6900 完成了 Ascend Quickstart 文档的大规模重构并新增四种训推后端组合脚本,本 PR 进一步优化了该文档的目录、表格说明和链接指向,使其更易用。
参与讨论