mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
docs(ai-plan): 更新文档治理恢复点
- 更新 documentation-full-coverage-governance tracking 到 RP-015 并记录 boot 后的 Godot 巡检结果 - 补充 trace 中的 validation-only 结论与最新验证记录
This commit is contained in:
parent
1a62f337a6
commit
2fa19f89b6
@ -12,7 +12,7 @@
|
||||
|
||||
## 当前恢复点
|
||||
|
||||
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-014`
|
||||
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-015`
|
||||
- 当前阶段:`Phase 5 - Governance Maintenance`
|
||||
- 当前焦点:
|
||||
- 继续巡检 `Godot` / `Game` 相关 README、landing page、tutorial 与 API reference 的 cross-link 是否回漂
|
||||
@ -88,6 +88,7 @@
|
||||
- 扩充 `docs/zh-CN/source-generators/index.md` 的 Godot 选包说明,把 Scene / UI 包装与导出集合注册辅助纳入入口摘要
|
||||
- 重写 `docs/zh-CN/godot/storage.md`,补齐 frontmatter、`GodotFileStorage` 的路径语义、repository 分工与 `GodotYamlConfigLoader` 分流边界
|
||||
- 重写 `docs/zh-CN/godot/setting.md`,改回当前 `ISettingsModel` / `RegisterApplicator(...)` 口径,并补上 `LocalizationMap` fallback 与 `CoreGrid` 注册示例
|
||||
- `2026-04-23` 再次通过 `$gframework-boot` 恢复当前 worktree 后,按 `Godot` docs surface 执行 validation-only 巡检,确认 `GFramework.Godot/README.md`、`docs/zh-CN/godot/index.md`、`storage.md`、`setting.md`、`docs/zh-CN/source-generators/index.md`、`docs/zh-CN/api-reference/index.md` 与 `docs/zh-CN/tutorials/godot-integration.md` 仍保持一致的 owner / adoption path 叙述,没有出现自 `RP-014` 之后的新漂移
|
||||
|
||||
## Inventory(第一版)
|
||||
|
||||
@ -140,6 +141,9 @@
|
||||
- 最新稳定性巡检结论:
|
||||
- `2026-04-23` 重新执行 `Godot` docs surface 巡检
|
||||
- 结果:通过;根入口链路保持稳定,并额外发现 `docs/zh-CN/godot/storage.md`、`setting.md` 两页存在旧版叙述残留,当前已按源码口径完成最小修复
|
||||
- 最新 validation-only 巡检结论:
|
||||
- `2026-04-23` 通过 `$gframework-boot` 恢复后重新执行 `Godot` docs surface 巡检
|
||||
- 结果:通过;`README / landing / topic / tutorial / API reference` 当前仍保持同一套 `Godot` owner / adoption path 叙述,本轮无需新增文档补丁
|
||||
- 最新恢复治理结论:
|
||||
- `2026-04-23` 重新读取 `ai-plan/public/archive/documentation-governance-and-refresh/**`
|
||||
- 结果:通过;确认 `Godot` family 适合把最小恢复摘要迁回 active topic,但不需要把整段归档历史重新放回默认 `boot` 路径
|
||||
@ -161,6 +165,10 @@
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/tutorials/godot-integration.md`:通过
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/storage.md`:通过
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/setting.md`:通过
|
||||
- `2026-04-23` `python3 .agents/skills/gframework-doc-refresh/scripts/scan_module_evidence.py Godot`:通过(boot 后复核)
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/storage.md`:通过(boot 后复核)
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/setting.md`:通过(boot 后复核)
|
||||
- `2026-04-23` `cd docs && bun run build`:通过(boot 后复核;仅保留既有 VitePress 大 chunk warning)
|
||||
|
||||
## 下一步
|
||||
|
||||
|
||||
@ -481,6 +481,56 @@
|
||||
`README.md` / landing page 是否仍保持同一套职责边界
|
||||
2. 当后续分支再修改 `Godot` / `Game` family 的 README、docs 或公共 API 时,回到对应模块追加 targeted 巡检与验证
|
||||
|
||||
### 当前恢复点:RP-015
|
||||
|
||||
- 通过 `$gframework-boot` 恢复当前 worktree 后,继续按 `documentation-full-coverage-governance` 的默认下一步执行一次
|
||||
validation-only 巡检,并补读:
|
||||
- `GFramework.Godot/README.md`
|
||||
- `docs/zh-CN/godot/index.md`
|
||||
- `docs/zh-CN/godot/storage.md`
|
||||
- `docs/zh-CN/godot/setting.md`
|
||||
- `docs/zh-CN/source-generators/index.md`
|
||||
- `docs/zh-CN/api-reference/index.md`
|
||||
- `docs/zh-CN/tutorials/godot-integration.md`
|
||||
- `GFramework.Godot/Setting/GodotAudioSettings.cs`
|
||||
- `GFramework.Godot/Setting/GodotGraphicsSettings.cs`
|
||||
- `GFramework.Godot/Setting/GodotLocalizationSettings.cs`
|
||||
- `GFramework.Game.Tests/Setting/GodotLocalizationSettingsTests.cs`
|
||||
- 同时重新执行 `python3 .agents/skills/gframework-doc-refresh/scripts/scan_module_evidence.py Godot`,确认 `Godot`
|
||||
docs surface 仍然覆盖 landing、`storage.md`、`setting.md`、source-generators fallback、API reference 与
|
||||
CoreGrid 参考接线,没有新的默认恢复页缺口
|
||||
- 巡检结论:
|
||||
- `GFramework.Godot/README.md`、`docs/zh-CN/godot/index.md`、`storage.md`、`setting.md`、`docs/zh-CN/source-generators/index.md`、
|
||||
`docs/zh-CN/api-reference/index.md` 与 `docs/zh-CN/tutorials/godot-integration.md` 当前仍保持同一套
|
||||
`Godot` owner / adoption path 叙述,没有发现自 `RP-014` 之后的新入口漂移
|
||||
- `setting.md` 里关于 `ISettingsModel`、`RegisterApplicator(...)`、`LocalizationMap` fallback 的描述,仍与
|
||||
`GodotAudioSettings`、`GodotGraphicsSettings`、`GodotLocalizationSettings` 以及
|
||||
`GodotLocalizationSettingsTests` 保持一致
|
||||
- 因此本轮执行的唯一修改是:
|
||||
- 更新 active tracking 与 trace 的恢复点、巡检结论和验证结果
|
||||
|
||||
### 当前决策(RP-015)
|
||||
|
||||
- 当前 topic 继续维持“巡检优先、无漂移则只更新 recovery artifact”的治理节奏,不为凑改动重写稳定页面
|
||||
- `boot` 恢复本身也应留下可复用的恢复证据,避免下一次启动时重复判断“最近一次巡检是否已经覆盖 `storage.md` /
|
||||
`setting.md`”
|
||||
|
||||
### 当前验证(RP-015)
|
||||
|
||||
- 模块扫描:
|
||||
- `python3 .agents/skills/gframework-doc-refresh/scripts/scan_module_evidence.py Godot`:通过
|
||||
- 文档校验:
|
||||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/storage.md`:通过
|
||||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/setting.md`:通过
|
||||
- 构建校验:
|
||||
- `cd docs && bun run build`:通过;仅保留既有 VitePress 大 chunk warning,无构建失败
|
||||
|
||||
### 下一步
|
||||
|
||||
1. 若后续分支继续调整 `GFramework.Godot` 运行时入口,优先复核 `docs/zh-CN/godot/storage.md`、`setting.md` 与根
|
||||
`README.md` / landing page 是否仍保持同一套职责边界
|
||||
2. 当后续分支再修改 `Godot` / `Game` family 的 README、docs 或公共 API 时,回到对应模块追加 targeted 巡检与验证
|
||||
|
||||
### 当前恢复点:RP-014
|
||||
|
||||
- 继续沿用 `RP-013` 的 `Godot` docs surface 巡检范围,补读:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user