mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-13 06:04:30 +08:00
54b8e5770a
- 优化根 README、模块 README 与抽象层页面的 reader-facing 文案和语义化链接标签 - 补充 tutorials、troubleshooting、best-practices、contributing、godot/resource 的代码块语言标记 - 更新 documentation-full-coverage-governance 的恢复点、验证结果与批处理停止条件
55 lines
5.2 KiB
Markdown
55 lines
5.2 KiB
Markdown
# Documentation Full Coverage Governance Trace
|
||
|
||
## 2026-04-25
|
||
|
||
### 当前恢复点：RP-035
|
||
|
||
- 本轮按 `$gframework-batch-boot 50` 执行，baseline 重新对齐到最新 `origin/main`（`4ad880c`，`2026-04-25 14:35:38 +08:00`）；重新开始时 committed branch diff 为 `0 / 50` 个 changed files。
|
||
- 已接受 worker 批次 `094e29e`（`docs(docs): 统一中文文档导航与语义化链接文案`），该提交补齐了 `abstractions` / `source-generators` / `api-reference` 的中文导航入口，并修复了 `ecs`、`game`、`godot` 目标页面的路径式可见链接标签。
|
||
- 主线程接收并复核了 `abstractions` 2 页 reader-facing 链接标签修正、`best-practices` 2 页和 `troubleshooting` 1 页的代码块语言标记补齐，以及 `tutorials` 10 页目录树 / 路径 / 输出块统一显式标记为 `text`。
|
||
- 主线程还接收了根 README 与 7 个模块 README 的 reader-facing XML 阅读入口改写，并补齐了 `docs/zh-CN/contributing.md`、`docs/zh-CN/godot/resource.md` 的剩余 bare opening fence。
|
||
- 当前未提交工作树连同 active tracking / trace 一并落地后，累计 branch diff 将达到 `34 / 50` 个 changed files；本轮在未触及阈值的情况下停止，因为同类低风险、可重复批处理切片已基本耗尽。
|
||
|
||
### 当前决策（RP-035）
|
||
|
||
- 继续沿用“导航 / 链接标签”和“bare opening fence 语言标记”两类低语义风险规则，但拒绝把 closing fence 或复杂嵌套 fenced 结构纳入同一自动批处理模板。
|
||
- 对 worker 产出的代码块标记批次一律做主线程复核；发现 closing fence 被误改后已在本轮立即纠正，并把后续批次提示词收紧到“只改 opening fence”。
|
||
- README 治理批次只改 reader-facing 标题、导语和链接可见标签，不删除现有表格、证据链或源码 / 测试导向的阅读线索。
|
||
- 在 `34 / 50` 之前停止本轮，不是因为 headroom 不足，而是因为自动可识别、风险可控的重复切片已经收敛到仅剩 `docs/zh-CN/contributing.md:631` 的既有嵌套 fenced 警告；该问题更适合后续人工结构化处理。
|
||
|
||
### 当前验证（RP-035）
|
||
|
||
- README / 链接校验：
|
||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-links.sh README.md GFramework.Core/README.md GFramework.Core.Abstractions/README.md GFramework.Game/README.md GFramework.Game.Abstractions/README.md GFramework.Game.SourceGenerators/README.md GFramework.Ecs.Arch/README.md GFramework.Ecs.Arch.Abstractions/README.md`
|
||
- 结果：通过；根 README 与本轮触达的模块 README 链接目标有效。
|
||
- 教程校验：
|
||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/tutorials`
|
||
- 结果：通过；本轮新增触达的 10 个教程页与其余教程页 frontmatter、链接、代码块校验均通过。
|
||
- 最佳实践校验：
|
||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/best-practices`
|
||
- 结果：通过；`index.md` 与 `architecture-patterns.md` 的代码块标记补齐后栏目验证通过。
|
||
- 单页校验：
|
||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/troubleshooting.md`
|
||
- 结果：通过；错误输出与完整错误信息块补齐为 `text` 后页面验证通过。
|
||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/contributing.md`
|
||
- 结果：通过，但保留 `docs/zh-CN/contributing.md:631` 的既有嵌套 fenced 示例警告。
|
||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/resource.md`
|
||
- 结果：通过；剩余 bare opening fence 已补齐语言标记。
|
||
- 站点构建：
|
||
- `bun run build`（工作目录：`docs/`）
|
||
- 结果：通过；本轮导航补齐、README reader-facing 改写与教程 / 排障 / 资源页代码块语言标记更新后站点仍可构建，仅保留既有大 chunk warning。
|
||
|
||
### 归档指针
|
||
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-through-rp-007.md`
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-status-history-through-rp-016.md`
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-status-history-rp-023-to-rp-025-2026-04-24.md`
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-through-rp-016.md`
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-rp-023-to-rp-025-2026-04-24.md`
|
||
|
||
### 下一步
|
||
|
||
1. 若继续下一轮，优先重新抓取 `$gframework-pr-review`，确认 PR `#287` 的 latest-head review 是否还有 open thread，再决定是否进入新的非重复性 reader-facing 文档巡检。
|
||
2. 下一轮若仍要扩批，优先人工评估 `docs/zh-CN/contributing.md:631` 的嵌套 fenced 示例是否值得结构化改写，而不是继续沿用本轮的 opening-fence-only 自动修正规则。
|
||
3. 当前轮次建议在 `34 / 50` 停止并提交，后续若要继续，应以新的低风险模式或新的热点清单重新建批。
|