已开启
[Documentation|文档反馈]: 约 4 个文档标题手工添加序号(最新 master 核验仍存在) #40
廖氏如神创建于  12 天前
廖氏如神
廖氏如神
12 天前 创建

问题描述

ops-ras 仓库多个 Markdown 文档的章节标题手工添加了序号(如 ## 1. …、### 1.1 …),涉及约 4 个文档(抽样合计 30 处)。已通过 contents API 对最新 master 核验,问题在当前分支仍然存在。

涉及文件最多的 5 个:

# 文件 手工序号标题数
1 docs/QUICKSTART.md 11
2 docs/QUICKSTART_en.md 11
3 docs/en/debug/op_debug_prof.md 4
4 docs/zh/debug/op_debug_prof.md 4

样例(docs/QUICKSTART.md):

### 1. 进入项目源码

规范依据

CANN 社区《文档写作规范》「标题」一节要求标题简洁并能概括章节核心内容,不应在标题文字中手工添加序号(层级由文档结构本身表达)。

影响分析

  1. 手工序号在章节增删时需要人工重排全部编号,极易跳号、重号;
  2. 含序号锚点(如 #1-environment-setup)在章节重排后失效,文档内互相引用与外部跳转易断链;
  3. 全仓范围的习惯性写法,建议一并治理避免新文档延续。

修复建议

移除标题中手工添加的序号,保留标题文字本身;涉及中英文成对文档的同步修改。可分批处理(优先 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:标题格式类问题,不影响内容正确性。

likedislike
yue-ma成员
11 天前 评论:

/assign @LiuZonggu

likedislike
CANN-robotCANN-robot成员
11 天前 将 LiuZonggu 设为负责人
yue-ma成员
11 天前 评论:

您好,已收到反馈,待分析确认

likedislike