已开启
[Documentation|文档反馈]: 修复文档中文标点、失效链接、图片命名与公网地址声明表问题 #318
高煜博创建于  13 天前
高煜博
高煜博成员
13 天前 创建

Document Link(文档链接)

  • AGENTS.md
  • README.md / README_en.md
  • SECURITY.md / SECURITY_en.md
  • autofuse/README.md
  • autofuse/tests/st/att/testcase/scenario/profiler/ReadMe.md
  • docs/zh/autofuse/design/features/reduce.md、slice_split.md
  • docs/en/autofuse/design/features/codegen.md、schedule.md
  • docs/zh/build.md、docs/zh/precommit_guide.md
  • docs/zh/super_kernel/super_kernel_migration_design.md
  • super_kernel/README.md、super_kernel/README_en.md
  • super_kernel/examples/super_kernel_runtime_ascendc_only/README.md
  • scripts/check_env.sh

Issues Section(问题文档片段)

  • **触发场景**: 编译、构建、build...(中文语境英文冒号)
  • y (动态)(中文语境英文括号)
  • - [AutoFuse 架构说明](docs/zh/autofuse/design/architecture.md)(失效链接)
  • ICachePreload_ optimization.svg(图片文件名含空格)

Existing Issues(存在的问题)

  1. 中文语境使用英文标点(冒号/括号/逗号)约 90 处:AGENTS.md(6 处)、SECURITY.md(3 处)、docs/zh/precommit_guide.md(46 处)、docs/zh/autofuse/design/features/reduce.md(12 处)、slice_split.md(9 处)、docs/zh/build.md(2 处)、super_kernel 相关文档(6 处)等。
  2. 失效链接:architecture.md 已由 design/ 迁移至 introduction/(commit 035eed5d、3f0fb3e1),但 README.md 第 32 行、README_en.md 第 31 行,以及 docs/en/autofuse/design/features/codegen.md 第 423 行、schedule.md 第 274 行的 \.\./architecture.md 仍指向旧路径。
  3. super_kernel/README.md 含 17 个 U+200B 零宽空格(分布于 9 行),导致有序列表无法被 Markdown 正常渲染。
  4. 图片文件名含空格:docs/{zh,en}/super_kernel/figures/ 下 ICachePreload_ optimization.{svg,excalidraw} 与 super kernel_diagram.excalidraw,共 6 个文件。
  5. SECURITY.md/SECURITY_en.md 公网地址声明表:makeself 行引用的 cmake/third_party/makeself-fetch.cmake 已不存在(该 URL 实际位于 docs/zh/build.md 与 docs/en/build.md 的下载说明中);cmake/fetch_cann_cmake.cmake 第 26 行的 https://gitcode.com/cann/cmake.git 未声明。
  6. README.md/README_en.md 目录树遗漏 docs/ 下 env_install/、figures/、guidelines/ 子目录及 scripts/reject_forbidden_paths.sh。
  7. docs/zh/build.md 第 289 行以 python3.7.5 为示例路径,与 Python3>=3.8.0 依赖要求矛盾;check_env.sh 的 GCC 检查注释称 build.md 未列出 GCC 且未校验 >= 7.3.0,与 build.md 现状不符。
  8. autofuse/README.md 第 49 行 Pytorch 与 PyTorch 大小写混用(3 处)。

修复方案见关联 PR。

likedislike
高煜博高煜博成员
13 天前 关联了pull request:docs: 修复文档中文标点、失效链接、图片命名与公网地址声明表(#318)
Ggaoxin成员
13 天前 将 hamburgerbobo 设为负责人
高煜博
高煜博成员
13 天前 评论:

SuperKernel 相关文档问题(super_kernel/README.md 的 U+200B 清理、figures/ 含空格文件名重命名、super_kernel_migration_design.md 标点修正、examples README 标点修正)按要求不在 PR #2136 中处理,留待后续单独提交。其余问题均由 PR #2136 修复。

likedislike
高煜博高煜博成员
8 天前 关联了pull request:docs: 修复文档中文标点、失效链接与公网地址声明表(#318)