文档体系重组与 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:
@@ -5,7 +5,7 @@ description: docs/ 文档技术配图绘制流程(精确布局图用 SVG 生
|
||||
|
||||
# 文档配图绘制(SVG / Mermaid)
|
||||
|
||||
`docs/` 文档技术配图的统一流程;完整选型依据 / 约定 / 检查清单见 `docs/图形绘制流程.md`。**产物统一放 `docs/images/`**(专门配图目录,`.svg` 入库;PNG 预览属本地派生物、不入库)。
|
||||
`docs/` 文档技术配图的统一流程;完整选型依据 / 约定 / 检查清单见 `docs/架构设计/图形绘制流程.md`。**产物统一放 `docs/images/`**(专门配图目录,`.svg` 入库;PNG 预览属本地派生物、不入库)。
|
||||
|
||||
## 工具选型
|
||||
|
||||
@@ -42,7 +42,7 @@ description: docs/ 文档技术配图绘制流程(精确布局图用 SVG 生
|
||||
```
|
||||
|
||||
4. **目检**:浏览器打开 `docs/images/*.svg`——文字不溢出盒外、框 / 线 / 标签对齐、配色符合调色板。
|
||||
5. **md 引用**(相对路径):`docs/` 根的 md 写 ``;`docs/UI 设计/` 等子目录 md 写 ``。
|
||||
5. **md 引用**(相对路径):`docs/` 根的 md 写 ``;`docs/UI设计/` 等子目录 md 写 ``。
|
||||
6. **提交**:生成器脚本(源)+ 生成的 `.svg`(产物)**一并**提交。
|
||||
|
||||
## SVG 约定(手写 / 新增生成器必须遵循)
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 重生成中文子集字体 ui_font_cn_12(extract_cn 提取 → m
|
||||
|
||||
# 中文字体重生成
|
||||
|
||||
本工程**唯一字体** `ui_font_cn_12`(宋体 12px 1bpp 子集,MCU/模拟器双端共用)。**缺字渲染为空白**——新增汉字必须走以下固定顺序,不得跳过或调换。详细原理见 `docs/UI 设计/UI_中文字体生成与配置.md`。
|
||||
本工程**唯一字体** `ui_font_cn_12`(宋体 12px 1bpp 子集,MCU/模拟器双端共用)。**缺字渲染为空白**——新增汉字必须走以下固定顺序,不得跳过或调换。详细原理见 `docs/UI设计/UI_中文字体生成与配置.md`。
|
||||
|
||||
## 固定顺序(仓库根目录执行)
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: UI 改动后的回归验证:5 步门禁(模拟器构建、菜
|
||||
|
||||
# UI 回归验证
|
||||
|
||||
UI 相关改动完成后必须跑完 5 个门禁再提交。完整说明见 `docs/UI 设计/UI_自动化测试流程.md`。
|
||||
UI 相关改动完成后必须跑完 5 个门禁再提交。完整说明见 `docs/UI设计/UI_自动化测试流程.md`。
|
||||
|
||||
## 步骤(仓库根目录执行,python 一律用 .venv)
|
||||
|
||||
@@ -42,4 +42,4 @@ cmake --build simulator/build --config Debug # 0) 构建模拟器(须 0 警
|
||||
- `.venv` 缺失/换机:`& 'C:\ProgramData\anaconda3\python.exe' -m venv .venv; & '.venv\Scripts\python.exe' -m pip install -r requirements.txt`
|
||||
- 新增 UI `.c` 文件先走 `new-source-file` skill 双端注册,否则一端静默缺文件
|
||||
- 字体重生成后全页大面积像素差异属预期:确认字形正确后 `--update` 刷参考
|
||||
- 涉及新界面/大改时本 skill 是 P3 门禁,完整管线(P0~P5)见 `docs/UI 设计/UI_界面制作流程.md`
|
||||
- 涉及新界面/大改时本 skill 是 P3 门禁,完整管线(P0~P5)见 `docs/UI设计/UI_界面制作流程.md`
|
||||
|
||||
Reference in New Issue
Block a user