Closed
[Documentation|文档反馈] 资料贡献指南"链接关系图"中的路径失效(zh/en 各 3 处) #145
gao_dafaAdd on  10 days agoClosed at  9 days ago
gao_dafaCollaborators
10 days ago Create

Document Link(文档链接)

Issues Section(问题文档片段)

docs/zh/contributing/doc_contributing.md:101
README.md ──构建测试──→ docs/zh/guide/build_and_test.md

docs/zh/contributing/doc_contributing.md:107
docs/README.md ──构建测试──→ docs/zh/guide/build_and_test.md

docs/zh/contributing/doc_contributing.md:115
docs/zh/api/ ───调用示例──→ examples/aicore/hcomm/01_hcomm_write_read_nbi/README.md

(英文版 docs/en/contributing/doc_contributing.md:101、107、115 为相同内容的英文描述,路径同样失效。)

Existing Issues(存在的问题)

"资料体系与链接关系"图中的两条路径已过期:

  1. docs/zh/guide/build_and_test.md 不存在——commit 4ff8d6b 调整目录结构时该文档已迁移到 docs/zh/compilation/build_and_test.md,贡献指南未同步。与本文档第 11 行"构建与依赖 | docs/zh/compilation"自相矛盾。
  2. examples/aicore/hcomm/01_hcomm_write_read_nbi 已在 commit 94c5e6b 改名为 01_hcomm_urma_write_read_nbi。

这两处位于 ```text 代码块内,scripts/markdown_link_check.sh(lychee)不会检查代码块内容,属于链接检查工具的盲区,常规门禁无法发现。

修复建议(Fix Suggestion)

docs/zh/contributing/doc_contributing.md(第 98-116 行代码块内):

-README.md ──构建测试──→ docs/zh/guide/build_and_test.md
+README.md ──构建测试──→ docs/zh/compilation/build_and_test.md
-docs/README.md ──构建测试──→ docs/zh/guide/build_and_test.md
+docs/README.md ──构建测试──→ docs/zh/compilation/build_and_test.md
-docs/zh/api/ ───调用示例──→ examples/aicore/hcomm/01_hcomm_write_read_nbi/README.md
+docs/zh/api/ ───调用示例──→ examples/aicore/hcomm/01_hcomm_urma_write_read_nbi/README.md

docs/en/contributing/doc_contributing.md(第 98-116 行代码块内)做对应英文替换:

-          ──build & test──→ docs/zh/guide/build_and_test.md
+          ──build & test──→ docs/zh/compilation/build_and_test.md
-               ──build & test──→ docs/zh/guide/build_and_test.md
+               ──build & test──→ docs/zh/compilation/build_and_test.md
-             ──invocation example──→ examples/aicore/hcomm/01_hcomm_write_read_nbi/README.md
+             ──invocation example──→ examples/aicore/hcomm/01_hcomm_urma_write_read_nbi/README.md

验证方式:ls docs/zh/compilation/build_and_test.md、ls examples/aicore/hcomm/01_hcomm_urma_write_read_nbi/README.md;并人工核对两个贡献指南中的图与 docs/README.md 实际入口表一致。

likedislike
Ggao_dafaCollaborators
10 days ago Added label: documentation
Wwx369Collaborators
9 days ago Associated pull request
Wwx369Collaborators
9 days ago Assign wx369 as responsible person
wx369Collaborators
9 days ago Comments:

您好,感谢您的反馈,相关修改已在进行,近期回合入master

likedislike
Wwx369Collaborators
9 days ago changed custom state from 进行中 to 已完成
Wwx369Collaborators
9 days ago Close issue
CANN-robotCANN-robotCollaborators
9 days ago Added label: resolved