Closed
[Documentation|文档反馈] docs/README.md 目录树注释与实际目录职责不符 #146
gao_dafaAdd on  10 days agoClosed at  9 days ago
gao_dafaCollaborators
10 days ago Create

Document Link(文档链接)

Issues Section(问题文档片段)

docs/README.md:10
├── zh/guide/            # 中文使用、构建与测试指南

docs/README.md:12
├── zh/compilation/      # 构建及三方依赖文档

(英文版 docs/README_en.md:10:├── zh/guide/ # Chinese usage, build, and test guide,同样问题。)

Existing Issues(存在的问题)

commit 4ff8d6b 调整 docs 目录结构后,构建与测试文档已从 zh/guide/ 迁移到 zh/compilation/(docs/zh/compilation/build_and_test.md、dependencies.md)。但 docs 入口 README 的目录树中:

  • zh/guide/ 仍标注"中文使用、构建与测试指南",而该目录实际只含使用指南(hcomm_usage、四篇算子开发指南);
  • zh/compilation/ 已正确标注"构建及三方依赖文档"。

两条注释互相矛盾,会让贡献者/读者到 zh/guide/ 下找构建文档(doc_contributing.md 的链接关系图就因此写错了,见另一 issue)。

修复建议(Fix Suggestion)

docs/README.md:

-├── zh/guide/            # 中文使用、构建与测试指南
+├── zh/guide/            # 中文使用指南

docs/README_en.md:

-├── zh/guide/            # Chinese usage, build, and test guide
+├── zh/guide/            # Chinese usage guides

验证方式:ls docs/zh/guide/ 确认该目录下无构建测试文档;ls docs/zh/compilation/ 确认构建文档位置;与 docs/zh/contributing/doc_contributing.md 第 11 行"构建与依赖 | docs/zh/compilation"的口径一致。

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