# PR #6337 完整报告 - 仓库：`verl-project/verl` - 标题：[doc] chore: split install guidance and quickstart - 合并时间：2026-05-14 12:03 - 原文链接：http://prhub.com.cn/verl-project/verl/pull/6337 --- # 执行摘要 - 一句话：拆分 Ascend 安装与快速启动文档 - 推荐动作：本 PR 为文档重构，建议用户查阅新版文档以获取最新安装指导。对于开发者，可关注文档结构和版本表的维护方式。 # 功能与动机 原文档将安装和快速启动混在一起，不利于用户按需查阅。此 PR 旨在拆分两者，使安装指南和快速启动各自独立，并更新版本信息。 # 实现拆解 1. 删除旧文档 `ascend_quick_start.rst` 和 `ascend_sglang_quick_start.rst`。 2. 创建 `get_start/install_guidance.rst`：包含完整的安装指引，涵盖硬件支持、后端选择、vLLM 和 SGLang 路线的详细安装步骤。 3. 创建 `get_start/quick_start.rst`：提供快速启动示例，包括 Qwen2.5-0.5B GRPO 基础验证场景。 4. 更新 `docs/index.rst`：将 toctree 中的旧条目替换为新文件路径。 关键文件： - `docs/ascend_tutorial/get_start/install_guidance.rst`（模块 安装指南；类别 docs；类型 documentation）: 新增的安装指南核心文件，包含完整的硬件支持、后端选择、vLLM/SGLang 安装步骤、版本依赖表等信息。 - `docs/ascend_tutorial/get_start/quick_start.rst`（模块 快速启动；类别 docs；类型 documentation）: 新增的快速启动文档，提供 Qwen2.5-0.5B GRPO 基础验证场景及关键配置说明。 - `docs/index.rst`（模块 文档索引；类别 docs；类型 documentation）: 更新 toctree 以反映文档路径变更，确保导航正确。 - `docs/ascend_tutorial/quick_start/ascend_quick_start.rst`（模块 旧文档；类别 docs；类型 deletion）: 被删除的旧文档，内容已拆分到新文档中。 - `docs/ascend_tutorial/quick_start/ascend_sglang_quick_start.rst`（模块 旧文档；类别 docs；类型 deletion）: 被删除的旧文档，内容已拆分到新文档中。 关键符号：未识别 # 评论区精华 Review 中主要指出两个文档错误： - gemini-code-assist 发现 `quick_start.rst` 中的链接多了一个 `model_support/` 目录，导致链接失效； - 同文件中的 MoE 配置注释与示例值矛盾，注释要求 `enable_dp_attention=True` 但示例设为 `False`。 另外 hustmf 要求将文档目录从 `quick_start` 改为 `get_start`，并删除多余内容、澄清部分表述。作者均已回复并修改合入。 - quick_start.rst 链接路径错误 (correctness): 作者已修复链接路径。 - enable_dp_attention 配置矛盾 (correctness): 作者已修正为 `True`。 - 文档目录结构调整 (documentation): 作者已将文件移至 `get_start`。 - 删除多余内容 (documentation): 作者已删除。 - 澄清 MindSpeed-LLM 描述 (documentation): 作者已在全篇调整相关描述。 # 风险与影响 - 风险：本次变更为纯文档结构调整，不涉及代码逻辑，主要风险在于文档路径变更可能导致旧链接失效，以及新增文档中的版本信息是否与当前一致。但已通过 index.rst 更新和内容审查降低风险。 - 影响：对用户：文档更清晰地划分安装与启动场景，但老用户需适应新路径。对系统：无影响。对团队：文档维护更模块化，易于更新。 - 风险标记：文档路径变更 , 链接失效风险 , 配置示例矛盾 # 关联脉络 - PR #6291 [doc] vLLM 路线版本更新 : install_guidance.rst 中明确引用了 PR #6291 作为 vLLM 路线版本更新的依据。 - PR #6617 [doc] chore: Update index.rst: 同一天合并的文档索引变更，与本 PR 的 index.rst 修改属于同一文档演进线。