Prhub

#7729 [doc] fix: fix old URL of ascend doc

原始 PR 作者 yyyy2000 合并时间 2026-09-04 17:21 文件变更 9 提交数 12 评论 0 代码增减 +22 / -22

执行摘要

更新昇腾教程文档中过时的外部链接和内部路径。

PR body 明确说明动机为“fix old URL of ascend doc”,即修复旧的URL。结合近期PR #7622([doc] fix: update broken external links)的背景,这是仓库持续维护文档链接有效性工作的一部分,避免用户访问到已失效或已迁移的外部页面。

此PR为常规文档维护,无需精读。值得关注的实践是链接管理策略:将项目内部文档引用统一改为相对路径,并定期扫描修复外部失效链接,这是保障大型项目文档健康度的有效模式。

讨论亮点

无评论讨论。审核者 wucong25 直接给予了APPROVED状态。

实现拆解

  1. 更新外部链接至最新URL:在多个文档文件中,将指向华为昇腾社区(hiascend.com)的旧版文档链接(如 /Pytorch/600/ 或 /Pytorch/730/ 路径)统一更新为 /Pytorch/latest/ 路径下的新地址,并调整了部分链接文本以匹配新文档标题。
  2. 将绝对路径链接改为相对路径:在 docs/ascend_tutorial/zh 目录下的内部链接中,将使用 https://github.com/verl-project/verl/blob/main/... 绝对路径的链接,替换为相对于当前文件的相对路径(如 ../../get_start/install_guidance.rst),以增强文档在本地构建或分支切换时的健壮性。
  3. 修正外部工具链接:对引用的第三方工具文档(如 MindStudio Insight、MSTT rl_analysis、msleaks 工具)的链接进行同样更新或修正。
  4. 配套验证:本次变更仅涉及文档,无代码逻辑修改,无需配套测试或部署调整。链接有效性可通过CI或手动检查验证。
文件 模块 状态 重要度
docs/ascend_tutorial/zh/dev_guide/performance/perf_tuning_on_ascend.rst 性能调优指南 modified 2.57
docs/ascend_tutorial/zh/dev_guide/model_dev/transfer_to_npu_guide.md 模型迁移指南 modified 2.43
docs/ascend_tutorial/zh/model_support/examples/gspo_optimization_practice.md 调优实践示例 modified 2.51

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

风险极低。变更仅涉及文档内容,不影响运行时逻辑、性能或安全性。主要风险在于新链接的准确性,若更新后的URL仍为错误地址,可能导致用户访问失败。但此类风险可通过链接检查工具(如PR #7622中所使用的)在CI中持续监控。

影响范围:所有查阅昇腾教程文档的用户,特别是新用户和需要参考性能调优、安装指南的开发者。影响程度:轻微正面影响。通过修复失效链接,提升了文档的可访问性和用户体验,并通过内部相对路径化增强了文档仓库的长期维护性。

文档链接准确性

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论