执行摘要
本PR修复了 docs/ascend_tutorial/zh 下9个文档文件中的过时外部链接和内部绝对路径,将其分别指向华为昇腾社区最新文档地址和项目内相对路径。变更为纯文档维护,影响范围限于昇腾教程的阅读体验,风险极低。
功能与动机
PR 标题明确为 [doc] fix: fix old URL of ascend doc。动机是保持文档链接的有效性,避免用户访问到华为昇腾社区已迁移或版本过时的页面。参考近期 PR #7622([doc] fix: update broken external links),这是仓库持续文档健康度维护的一部分。
实现拆解
- 外部链接更新:将所有指向
hiascend.com 文档的旧版路径(如 /Pytorch/600/、/Pytorch/730/、/mindstudio/80RC1/ 等)统一更新为 /latest/ 路径下的新地址。例如,性能调优指南中的 RotaryMul、RmsNorm、Swiglu、GroupMatMul 等算子的参考文档链接均已更新。
- 内部链接相对化:将
transfer_to_npu_guide.md、parameter_and_metrics.md、quick_start.rst、install_guidance.rst 等文件中使用 GitHub 绝对路径(https://github.com/verl-project/verl/blob/main/docs/...)的链接,改为相对于当前文件的路径(如 ../../get_start/install_guidance.rst)。
- 工具链接修正:修正了
ascend_profiling.rst 和 ascend_performance_analysis_guide.md 中对 MindStudio Insight、MSTT rl_analysis、msleaks 工具等第三方文档的引用。
本次变更均为文档链接,不涉及源码逻辑,无需展示代码片段。
评论区精华
无评论讨论。审核者 wucong25 直接批准合并。
风险与影响
- 风险:极低。唯一风险是新链接的准确性,若更新后的 URL 仍有误,可能导致用户无法访问。但此类问题可通过自动化链接检查在 CI 中持续监控。
- 影响:轻微正面。提升了昇腾文档的准确性和可维护性,确保用户(尤其是新用户)能够顺利访问到正确的参考文档。
关联脉络
与 PR #7622([doc] fix: update broken external links)构成连续的文档维护工作流,共同保障项目文档(特别是昇腾相关部分)链接的健康度。近期还有多个 PR(如 #7632、#7648)涉及文档更新,表明社区正系统化地提升文档质量。
参与讨论