文档体系重组与 D-7 一致性门禁落地,清理芯片手册孤儿图片
- D-6 目录规范化:docs 根目录散落文档归入 UI设计/子系统设计/架构设计/审查记录/ 环境与部署/网络 等子目录,去掉目录名空格,重命名 嵌入式C语言代码规范_V1.0.md - D-7 三档一致性门禁:新增 scripts/check_doc_links.py(链接存在性)、 scripts/gen_task_table.py(FreeRTOS 任务表数值)、scripts/check_mem_numbers.py (内存/Flash 体积),均支持 --check/--write/--diff,pre-commit 钩子同步注册 - D-5 文档索引:新建 docs/README.md,新建 docs/文档规范.md 约束目录命名与链接写法 - D-1 芯片手册瘦身:删除 1069 张无引用孤儿图片(77.06 MB), docs/芯片手册 120 MB → 41 MB,已引用图片零断链 - 同步 C 源码注释中的文档路径引用(D-6 重组后),构建 0 错误 0 警告
This commit is contained in:
@@ -104,3 +104,35 @@ repos:
|
||||
Src/|
|
||||
Inc/
|
||||
)
|
||||
|
||||
# 5) 文档一致性门禁(D-7)
|
||||
# 存在性:md 互链 / 反引号路径是否指向真实文件(防迁移/删除后残留死链)
|
||||
- id: doc-links
|
||||
name: 文档链接存在性 (D-3/D-7)
|
||||
entry: python scripts/check_doc_links.py
|
||||
language: system
|
||||
files: \.md$
|
||||
# 外部资料(芯片手册转录)链接形态不受控;第三方目录整体排除
|
||||
exclude: |
|
||||
(?x)^(
|
||||
\.opencode/node_modules/|
|
||||
Lib/lvgl/|
|
||||
simulator/|
|
||||
MDK-ARM/RTE/|
|
||||
docs/芯片手册/
|
||||
)
|
||||
# 数值:README/AGENTS 任务表须与 Src/freertos.c 一致(D-2/D-7)
|
||||
- id: task-table
|
||||
name: FreeRTOS 任务表一致性 (D-2/D-7)
|
||||
entry: python scripts/gen_task_table.py --check
|
||||
language: system
|
||||
files: ^(README\.md|AGENTS\.md|Src/freertos\.c)$
|
||||
pass_filenames: false
|
||||
# 体积:内存/Flash 数字须与最新 .map 一致(D-7 第三档)
|
||||
# 只在内存文档或代码变动时触发;.map 未生成时脚本自身给出明确提示
|
||||
- id: mem-numbers
|
||||
name: 内存/Flash 数字一致性 (D-7 体积档)
|
||||
entry: python scripts/check_mem_numbers.py --scan
|
||||
language: system
|
||||
files: ^(docs/内存管理/.*\.md|scripts/check_mem_numbers\.py|App/.*\.c|App/.*\.h|Src/.*\.c|Inc/.*\.h)$
|
||||
pass_filenames: false
|
||||
|
||||
Reference in New Issue
Block a user