远程 CI 文档独立成 docs/CI/:两篇重叠指南合并为一篇,AGENTS.md 压成一行指针
动因:远程 CI 只跑在本机一台 runner(win-stm32-ci)上,其他机器与项目都不涉及, 但内容散在 4 处约 2000 行——两篇高度重叠的指南躺在「环境与部署」里与换机核对清单 并列,AGENTS.md 提交门禁节还塞了 4 条 runner 运维经验,导致每次会话都被这些机器 专属细节干扰。 结构:新建 docs/CI/,README.md 作唯一入口(适用范围 + 章节速查 + 常用命令), 远程CI完整指南.md 为合并稿。 - 合并:CI配置指南 477 行 + Gitea_Runner部署指南 917 行 → 一篇 1300 行;骨架内容 逐行比对核实无丢失(仅章节重编号与相对链接按新位置改写),重复段按"留新版"去重, 独有内容全部搬入(下载/config.yaml 字段语义/不能用 Windows 服务的根因/内网 action 三种处置/check_env 自检/TL;DR/排障表 13 条独有行/MySQL 直查核验) - 再分配:测试流程 §9.2 两个 job 的步骤细节并入指南 §5.5、§9.4 部署前置表并入 §0.2; 测试流程 §9 只留测试分层视角(覆盖哪些层、触发与 paths-ignore、本地等价、 "CI 不替代本地门禁") - AGENTS.md:4 条 CI 经验(看门狗 / gitlint stage / UTF-16LE / CI 概览)压成 1 行指针 - 引用同步 6 个文件:docs/README 目录树与索引、项目部署环境要求 3 处、本地工具路径 环境变量方案、待处理内容、scripts/README(补登 3 个 CI 脚本并标注为本机专属) 验证:check_doc_links.py --all 125 篇 0 问题;pre-commit run --all-files 17 项全 Passed。 两篇旧文档以 git rm 删除(历史仍在 git 中);各文档变更记录的历史行按仓库惯例不改写, 只新增 2026-10-12 行。
This commit is contained in:
@@ -23,6 +23,7 @@ docs/
|
||||
├── 内存管理/ RAM 预算、分配策略与优化调研
|
||||
├── 问题记录/ 模块陷阱台账、专项审计与项目评审报告
|
||||
├── 环境与部署/ 环境搭建与部署核对清单
|
||||
├── CI/ 远程 CI(Gitea Actions)唯一入口 —— **只涉及本机一台 runner,日常开发不必读**
|
||||
├── UI设计/ UI 架构、页面设计、字体与模拟器
|
||||
├── 硬件平台/ 网表分析报告与语义图
|
||||
├── 芯片手册/ 外部芯片数据手册转录(只读资料)
|
||||
@@ -214,6 +215,7 @@ docs/
|
||||
| 文档 | 内容 |
|
||||
|---|---|
|
||||
| [`项目部署环境要求.md`](环境与部署/项目部署环境要求.md) | 开发机软件环境、目标板资源预算、现场部署与验收步骤 |
|
||||
| [`CI/README.md`](CI/README.md) | **远程 CI(Gitea Actions)唯一入口**:服务端开关 / runner 部署与保活 / workflow / 排障。**只涉及本机一台 runner `win-stm32-ci`,其他机器与项目都不涉及**;日常改代码用本地门禁 `scripts/ci_local.py`,不必读这里 |
|
||||
|
||||
### 9.3 台账与外部资料
|
||||
|
||||
@@ -262,6 +264,7 @@ docs/
|
||||
|
||||
| 日期 | 变更 | 说明 |
|
||||
|---|---|---|
|
||||
| 2026-10-12 | 远程 CI 文档独立成目录 | 新建 `docs/CI/`:原散在 4 处的远程 CI 内容(`环境与部署/CI配置指南.md` 477 行 + `环境与部署/Gitea_Runner部署指南.md` 917 行 + `测试开发标准流程.md` §9 + `AGENTS.md` 提交门禁节 4 条,共约 2000 行)**合并为 `CI/远程CI完整指南.md` 一篇**,`CI/README.md` 作唯一入口;`AGENTS.md` 压成一行指针、测试流程 §9 只留覆盖边界与本地等价。动因:远程 CI **只跑在本机一台 runner**,与日常开发规范混在一起每次会话都被读,造成困惑 |
|
||||
| 2026-10-10 | 新增子系统设计 | 新建 `docs/子系统设计/ADC采样节拍设计说明.md`(ADC 采集链路 1 kHz 硬件定时器触发的 CubeMX 配置规格与代码改造清单,B1 遗留项规划);本索引 §5.1 补登记 |
|
||||
| 2026-10-10 | 新增算法专题 | 新建 `docs/算法/继电保护功能复现规划.md`(保护链路复现总规划);本索引 §1 目录树补 `算法/`、§5 拆为 5.1 功能子系统 / 5.2 算法专题并登记 `算法/` 两篇文档 |
|
||||
| 2026-10-05 | 新增产品需求文档 | 新建 `docs/产品需求/产品需求设计文档.md`(面向产品的需求基线);本索引新增 §3 产品需求、§2 推荐阅读顺序置顶、§1 目录树补 `产品需求/`;后续章节号顺延(架构设计 §4 … 变更记录 §12) |
|
||||
|
||||
Reference in New Issue
Block a user