GFramework/ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
gewuyou 896e3efaa9 docs(source-generators): 收口 PR 审查中的文档入口表述
- 更新 source-generators 文档中的测试入口表述,使用语义化链接标签替代源码路径

- 校正 documentation-full-coverage-governance active ai-plan 的 PR 审查事实、验证结果与下一步恢复点
2026-05-01 15:37:26 +08:00

86 lines
7.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Documentation Full Coverage Governance 跟踪
## 目标
持续治理 `GFramework` 的 README、`docs/zh-CN`、站点导航、XML 文档和 API 参考链路,避免阶段性刷新完成后再次回漂。
- 用源码、测试、`*.csproj` 和必要的 `ai-libs/` 证据校正文档
- 以模块族为单位闭环 README、landing page、专题页、教程入口和 API 参考链路
- 把 XML 文档缺口与 reader-facing 采用路径持续纳入同一主题治理
## 当前恢复点
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-055`
- 当前阶段:`Phase 5 - Governance Maintenance`
- 当前焦点:
- 处理 PR `#308` 当前 latest-head review 与 outside-diff review 中经本地复核仍成立的 reader-facing 文档表述问题,并清理 active `ai-plan` 对旧结论的漂移
- 当前事实:
- `2026-05-01` 重新抓取 `$gframework-pr-review` 后确认PR `#308` 处于 `OPEN`latest reviewed commit 已前进到 `4fdb1e7398e4f114757b5c988698af203dce24c8`
- 当前 `CodeRabbit` 仍有 `2` 条 latest-head open threads 和 `1` 条 outside-diff comment本地复核后真正成立的是 `2` 条 reader-facing 文档问题,分别位于 `schema-config-generator.md``cqrs-handler-registry-generator.md` 的测试入口表述
- `docs/zh-CN/source-generators/schema-config-generator.md` 已包含独立的“迁移与兼容性”章节,因此对应 major open thread 现阶段应视为 stale等待提交推送后再由远端重新计算
- GitHub Test Reporter 汇总为 `2222 passed / 0 failed`
- `Title check` 仍为 `Inconclusive`,属于 PR 元数据问题,不是仓库文件内可直接修复的阻塞项
- 本地对 review 指向文件的修复在提交推送前,不会改变远端 latest reviewed commit 与 open-thread 统计
- 当前风险:
- 如果 active tracking / trace 继续保留旧的 commit SHA 和 review 归因,会让后续恢复点重复处理已经本地闭环的问题
- 在变更推送前PR 页面仍会继续展示旧的 open-thread / outside-diff 数量,容易把 stale 线程误判为新的本地缺陷
## 当前状态摘要
- `Core``Ecs.Arch``Cqrs``Game``Godot` 五个模块族当前都已有 README / landing / topic / API 参考层级的已验证入口。
- `source-generators` 栏目已经补出 `Schema 配置生成器` 专题页,并把 `Game.SourceGenerators` 接回 landing、API 入口与侧栏。
- `Cqrs.SourceGenerators` 的 fallback 精度、`GF_Cqrs_001` 诊断边界与共享支撑层阅读路线,当前已经回收进现有专题页与入口页,而不是继续扩成新的维护者导向页面。
- `RP-049``RP-052` 的阶段细节、逐命令验证和批次决策已迁入归档active 文档只保留当前恢复事实、风险、验证结果与下一步。
## 归档指针
- 详细验证历史(`RP-001``RP-007`
`ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-through-rp-007.md`
- 阶段状态归档(`RP-001``RP-016`
`ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-status-history-through-rp-016.md`
- 阶段状态归档(`RP-023``RP-025`
`ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-status-history-rp-023-to-rp-025-2026-04-24.md`
- 阶段状态归档(`RP-049``RP-052`
`ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-status-history-rp-049-to-rp-052-2026-05-01.md`
- 时间线归档(`RP-001``RP-016`
`ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-through-rp-016.md`
- 时间线归档(`RP-023``RP-025`
`ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-rp-023-to-rp-025-2026-04-24.md`
- 时间线归档(`RP-041``RP-048`
`ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-rp-041-to-rp-048-2026-04-28.md`
- 时间线归档(`RP-049``RP-052`
`ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-rp-049-to-rp-052-2026-05-01.md`
- 验证历史归档(`RP-041``RP-048`
`ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-rp-041-to-rp-048-2026-04-28.md`
- 验证历史归档(`RP-049``RP-052`
`ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-rp-049-to-rp-052-2026-05-01.md`
## 最新验证
- `2026-05-01` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/schema-config-generator.md`
- 结果:通过;在把测试入口改成语义化链接后,页面的 frontmatter、链接与代码块校验仍然通过。
- `2026-05-01` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/cqrs-handler-registry-generator.md`
- 结果:通过;测试源码路径改成语义化链接标签后,页面的 frontmatter、链接与代码块校验通过。
- `2026-05-01` `bun run build`(工作目录:`docs/`
- 结果:通过;两篇 source-generators 页面链接改写与 active `ai-plan` 事实更新后站点仍可构建,仅保留既有大 chunk warning。
- `2026-05-01` `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/current-pr-review.json`
- 结果通过PR `#308` 处于 `OPEN`latest reviewed commit 为 `4fdb1e7398e4f114757b5c988698af203dce24c8``CodeRabbit` 当前有 `2` 条 latest-head open threads 和 `1` 条 outside-diff comment测试汇总为 `2222 passed / 0 failed``Greptile` / `Gemini Code Assist` 当前无 open thread。
- `2026-04-30` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/schema-config-generator.md`
- 结果:通过;`Schema 配置生成器` 专题页的 frontmatter、链接与代码块校验通过。
- `2026-04-30` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/index.md`
- 结果通过source-generators landing 的链接与结构校验通过。
- `2026-04-30` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/cqrs-handler-registry-generator.md`
- 结果:通过;`Cqrs` generator 专题页在补足 fallback 精度说明后校验通过。
- `2026-04-30` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/core/cqrs.md`
- 结果:通过;`CQRS` 运行时页在补足 generated registry 协作说明后校验通过。
- `2026-04-30` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/api-reference/index.md`
- 结果通过API 入口页在补充 source-generator 阅读路线后校验通过。
- `2026-04-30` `bun run build`(工作目录:`docs/`
- 结果:通过;新增 source-generators 专题页与侧栏入口后站点仍可构建,仅保留既有大 chunk warning。
## 下一步
1. 提交并推送本轮 source-generators 文档 follow-up然后重新抓取 `$gframework-pr-review`
2. 若 remote open threads 只剩 stale 的“迁移与兼容性”线程或 `Title check` 这类 metadata 项,则停止本轮仓库内修复。
3. 若 review 线程清空或只剩 metadata 项,再按 `$gframework-batch-boot 50` 继续挑选新的 coverage 切片,避免在同一轮混入无关改稿。