ops-ras 仓库多个 Markdown 文档的章节标题手工添加了序号(如 ## 1. …、### 1.1 …),涉及约 4 个文档(抽样合计 30 处)。已通过 contents API 对最新 master 核验,问题在当前分支仍然存在。
ops-ras
## 1. …
### 1.1 …
涉及文件最多的 5 个:
docs/QUICKSTART.md
docs/QUICKSTART_en.md
docs/en/debug/op_debug_prof.md
docs/zh/debug/op_debug_prof.md
样例(docs/QUICKSTART.md):
### 1. 进入项目源码
CANN 社区《文档写作规范》「标题」一节要求标题简洁并能概括章节核心内容,不应在标题文字中手工添加序号(层级由文档结构本身表达)。
#1-environment-setup
移除标题中手工添加的序号,保留标题文字本身;涉及中英文成对文档的同步修改。可分批处理(优先 README/CONTRIBUTING/guide 等入口文档)。
git clone --depth 1 https://gitcode.com/cann/ops-ras.git cd ops-ras grep -rnE '^#{1,6} +[0-9]+[.、]' --include="*.md" . | wc -l
L1:标题格式类问题,不影响内容正确性。
/assign @LiuZonggu
您好,已收到反馈,待分析确认
问题描述
ops-ras仓库多个 Markdown 文档的章节标题手工添加了序号(如## 1. …、### 1.1 …),涉及约 4 个文档(抽样合计 30 处)。已通过 contents API 对最新 master 核验,问题在当前分支仍然存在。涉及文件最多的 5 个:
docs/QUICKSTART.mddocs/QUICKSTART_en.mddocs/en/debug/op_debug_prof.mddocs/zh/debug/op_debug_prof.md样例(
docs/QUICKSTART.md):### 1. 进入项目源码规范依据
CANN 社区《文档写作规范》「标题」一节要求标题简洁并能概括章节核心内容,不应在标题文字中手工添加序号(层级由文档结构本身表达)。
影响分析
#1-environment-setup)在章节重排后失效,文档内互相引用与外部跳转易断链;修复建议
移除标题中手工添加的序号,保留标题文字本身;涉及中英文成对文档的同步修改。可分批处理(优先 README/CONTRIBUTING/guide 等入口文档)。
问题复现方式
git clone --depth 1 https://gitcode.com/cann/ops-ras.git cd ops-ras grep -rnE '^#{1,6} +[0-9]+[.、]' --include="*.md" . | wc -l影响级别
L1:标题格式类问题,不影响内容正确性。