mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-13 06:04:30 +08:00
- 更新 documentation-full-coverage-governance 的恢复点与 Godot 页面集合 - 记录 validation-only 巡检结论、定向校验结果与后续恢复方向
30 KiB
30 KiB
Documentation Full Coverage Governance Trace
2026-04-22
当前恢复点:RP-001
- 按长期治理计划新建 active topic
documentation-full-coverage-governance - 在
ai-plan/public/README.md中将当前分支docs/sdk-update-documentation映射到该 topic - 复核已知缺口模块的
*.csproj后确认:GFramework.Ecs.Arch.Abstractions是可打包消费模块,需要独立 READMEGFramework.Core.SourceGenerators.Abstractions、GFramework.Godot.SourceGenerators.Abstractions、GFramework.SourceGenerators.Common都是IsPackable=false的内部支撑模块
- 基于该结论,本轮没有为内部支撑模块新增独立 README,而是在根 README 与 abstractions / API 入口中明确其 owner
当前决策
- 新主题的完成条件采用长期治理口径:
P0清零、无 README 缺失、无导航死链,并完成连续两轮稳定巡检 - 本轮先做治理基础设施与 inventory,不把整个长期计划伪装成单轮完成
api-reference页面改为“模块 -> README / docs / XML / tutorial”的阅读链路入口,避免继续维护失真的伪签名列表Ecs.Archfamily 被列为高优先 backlog:抽象层入口已补齐,但 runtime docs 仍需按源码重写Core/Core.Abstractions波次先收口 README、landing page 和 abstractions 页的目录映射,再补显式 XML 覆盖 inventory- VitePress 站内页面不直接链接仓库根模块
README.md;站内仅保留可构建的 docs 链接,模块 README 以文本路径或仓库 README 承接
当前恢复点:RP-002
- 完成
Core/Core.Abstractions的类型族级 XML inventory:GFramework.Core/README.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/core/index.mddocs/zh-CN/abstractions/core-abstractions.md
- 通过顶层目录轻量盘点确认:
GFramework.Core当前各目录族的公开 / 内部类型声明都已带 XML 注释GFramework.Core.Abstractions当前各契约目录族的公开 / 内部类型声明都已带 XML 注释
- 这轮 inventory 明确限定为“类型声明级基线”,不把结果表述成成员级 XML 合规审计
当前决策(RP-002)
- XML inventory 同时落在模块 README 和站内 landing page:
- README 提供仓库侧入口,方便从包目录直接恢复上下文
- docs landing 提供更细的类型族 / 代表类型 / 阅读重点表格,方便站内导航
Core波次在补齐基线后转入巡检,不继续在本轮展开成员级<param>/<returns>审计- 下一恢复点切换到
Ecs波次,优先处理仍明显失真的 runtime docs
当前验证
- 文档校验:
validate-all.sh docs/zh-CN/abstractions/index.md:通过validate-all.sh docs/zh-CN/abstractions/ecs-arch-abstractions.md:通过validate-all.sh docs/zh-CN/api-reference/index.md:通过validate-all.sh docs/zh-CN/core/index.md:通过validate-all.sh docs/zh-CN/abstractions/core-abstractions.md:通过
- 构建校验:
cd docs && bun run build:通过DOTNET_CLI_HOME=/tmp/dotnet-home dotnet build GFramework.Core.Abstractions/GFramework.Core.Abstractions.csproj -c Release -p:RestoreFallbackFolders=:通过,0 Warning(s) / 0 Error(s)dotnet build GFramework.Ecs.Arch.Abstractions/GFramework.Ecs.Arch.Abstractions.csproj -c Release -p:RestoreFallbackFolders=:通过,0 Warning(s) / 0 Error(s)
当前验证(RP-002)
- 文档校验:
validate-all.sh docs/zh-CN/core/index.md:通过validate-all.sh docs/zh-CN/abstractions/core-abstractions.md:通过
- 构建校验:
cd docs && bun run build:通过;仅保留 VitePress 大 chunk warning,无构建失败
当前恢复点:RP-003
- 完成
Ecs.Arch波次的运行时文档刷新:docs/zh-CN/ecs/index.mddocs/zh-CN/ecs/arch.mdGFramework.Ecs.Arch/README.md
- 为
Ecs.Arch.Abstractions补齐与运行时页同粒度的 XML inventory:GFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/abstractions/ecs-arch-abstractions.md
- 明确记录一个关键采用事实:
UseArch(...)必须早于Initialize()调用- 该结论以
ArchExtensions的模块注册方式和ExplicitRegistrationTests为证据
- 将
Ecs.Archfamily 从“入口存在但失真”推进到“README / landing / abstractions / XML inventory 已对齐源码与测试”
当前决策(RP-003)
Ecs波次继续采用与Core相同的治理粒度:- 模块 README 承担仓库入口
docs/zh-CN/ecs/index.md承担模块族 landingdocs/zh-CN/ecs/arch.md承担运行时默认实现专题页docs/zh-CN/abstractions/ecs-arch-abstractions.md承担契约边界专题页
EnableStatistics当前仅保留在公开配置面上;文档不再把它写成已验证的运行时行为- 下一恢复点切换到
Cqrs波次,优先解决入口分散和 API / XML 阅读链路不统一的问题
当前验证(RP-003)
- 文档校验:
validate-all.sh docs/zh-CN/ecs/index.md:通过validate-all.sh docs/zh-CN/ecs/arch.md:通过validate-all.sh docs/zh-CN/abstractions/ecs-arch-abstractions.md:通过
- 构建校验:
cd docs && bun run build:通过;仅保留 VitePress 大 chunk warning,无构建失败
下一步
- 在
Cqrs波次核对模块 README、docs/zh-CN/core/cqrs.md与docs/zh-CN/source-generators/**的真实 owner - 决定
Cqrsfamily 是补 dedicated landing 还是拆分现有入口页
当前恢复点:RP-004
- 完成
Cqrs波次的模块族入口刷新:- 重写
docs/zh-CN/core/cqrs.md - 新建
docs/zh-CN/source-generators/cqrs-handler-registry-generator.md - 更新
docs/zh-CN/source-generators/index.md - 更新
docs/zh-CN/api-reference/index.md - 更新
docs/.vitepress/config.mts
- 重写
- 将
Cqrsfamily 从“README 已存在但 generator 入口分散”推进到“runtime / abstractions / source generator 都有明确站内入口” - 为
GFramework.Cqrs/Internal/CqrsHandlerRegistrar.cs与GFramework.Cqrs.SourceGenerators/Cqrs/CqrsHandlerRegistryGenerator.cs中缺失的内部类型补齐 XML 注释 - 基于轻量扫描确认:
GFramework.Cqrs.Abstractions/Cqrs/当前类型声明级 XML 覆盖为20/20GFramework.Cqrs根入口与Internal/已补到19/19GFramework.Cqrs.SourceGenerators/Cqrs/当前类型声明级 XML 覆盖为3/3
当前决策(RP-004)
docs/zh-CN/core/cqrs.md继续保留在Core栏目,但其角色调整为Cqrsfamily landing,而不再只是 runtime 简介页Cqrs.SourceGenerators不单独新建一级导航栏目,而是在source-generators栏目内补一个专用专题页,保持站点 taxonomy 稳定- generator 入口以“专题页 + API reference 链接 + sidebar”三点联动,而不是只在
source-generators/index.md留一个段落链接 - XML inventory 仍维持“类型声明级基线”口径,不在本轮扩展成成员级
param/returns/exception细审
当前验证(RP-004)
- 文档校验:
validate-all.sh docs/zh-CN/core/cqrs.md:通过validate-all.sh docs/zh-CN/source-generators/cqrs-handler-registry-generator.md:通过
- 轻量 XML inventory:
GFramework.Cqrs/Internal/:14/14GFramework.Cqrs.Abstractions/Cqrs/:20/20GFramework.Cqrs.SourceGenerators/Cqrs/:3/3
- 构建校验:
dotnet build GFramework.Cqrs.SourceGenerators/GFramework.Cqrs.SourceGenerators.csproj -c Release -p:RestoreFallbackFolders=:通过cd docs && bun run build:通过;仅保留 VitePress 大 chunk warning,无构建失败dotnet build GFramework.Cqrs/GFramework.Cqrs.csproj -c Release:失败;当前 WSL / dotnet 环境仍引用失效的 Windows fallback package folder,并在多目标 inner build 阶段触发MSB4276/MSB4018
下一步
- 切换到
Gamefamily 波次,按Core/Ecs/Cqrs已验证模板继续补 XML inventory 与教程链路 - 把
GFramework.Cqrs的本地构建阻塞留给后续环境治理或构建脚本清理,不在本 topic 内扩张为环境修复任务
当前恢复点:RP-005
- 完成
Game波次的模块族入口刷新:- 更新
GFramework.Game/README.md - 更新
GFramework.Game.Abstractions/README.md - 更新
GFramework.Game.SourceGenerators/README.md - 更新
docs/zh-CN/game/index.md - 重写
docs/zh-CN/abstractions/game-abstractions.md
- 更新
- 将
Gamefamily 从“README / 页面存在但缺少可审计 XML 入口,且 abstractions 页失真”推进到“runtime / abstractions / source generator 都有声明级 XML inventory 与真实采用边界” - 基于轻量扫描确认:
GFramework.Game当前类型声明级 XML 覆盖为56/56GFramework.Game.Abstractions当前类型声明级 XML 覆盖为80/80GFramework.Game.SourceGenerators当前类型声明级 XML 覆盖为2/2
当前决策(RP-005)
docs/zh-CN/abstractions/game-abstractions.md不再维护虚构接口摘录,而是与源码中的Config/Data/Setting/Scene/UI/Routing契约分组保持一致Game.SourceGenerators继续以README + docs/zh-CN/game/config-system.md + docs/zh-CN/source-generators/index.md组成入口,不额外新增只为凑数量的专题页docs/zh-CN/game/index.md补 frontmatter,并承担Gamefamily 的 XML 基线入口;更细的类型族说明继续留在模块 README 与 abstractions 页
当前验证(RP-005)
- 文档校验:
validate-all.sh docs/zh-CN/abstractions/game-abstractions.md:通过validate-all.sh docs/zh-CN/game/index.md:通过
- 轻量 XML inventory:
GFramework.Game:56/56GFramework.Game.Abstractions:80/80GFramework.Game.SourceGenerators:2/2
- 构建校验:
cd docs && bun run build:通过;仅保留 VitePress 大 chunk warning,无构建失败
下一步
- 进入
Gamefamily 巡检,优先检查config-system.md、scene.md、ui.md与source-generators/index.md的交叉引用是否回漂 - 评估是否需要把
Godotfamily 的关键 XML inventory 摘要迁回 active topic,减少对 archive 的依赖
当前恢复点:RP-006
- 更新
AGENTS.md的 WSL Git 规则:- 将显式
git --git-dir=<...> --work-tree=<...>绑定提升为高于git.exe的默认优先级 - 明确 plain Linux
git命中 worktree 路径翻译错误时,应先切到显式绑定而不是直接改用git.exe - 明确
git.exe只有在当前会话可执行时才作为次级 fallback
- 将显式
- 记录本次恢复任务的环境偏差:
git.exe在当前 WSL 会话中可解析,但执行会触发Exec format error- plain
git会把 worktree 元数据路径翻译错并报“not a git repository” - 显式
--git-dir/--work-tree绑定是本次已验证可用的 Git 操作方式
当前决策(RP-006)
- 把 Git 回退顺序写进
AGENTS.md,而不是只留在一次性的聊天上下文里 - 不额外扩张
gframework-bootskill,因为它本身不内嵌 Git 选择逻辑,继续由AGENTS.md作为唯一准则 - 继续把
git.exe保留为 fallback,而不是完全删除,避免在可执行的 WSL 会话里丢掉可用路径
当前验证(RP-006)
- 构建校验:
cd docs && bun run build:通过;仅保留 VitePress 大 chunk warning,无构建失败
下一步
- 继续
Gamefamily 巡检,优先检查config-system.md、scene.md、ui.md与source-generators/index.md的交叉引用是否回漂 - 评估是否需要把
Godotfamily 的关键 XML inventory 摘要迁回 active topic,减少对 archive 的依赖
当前恢复点:RP-007
- 完成
Gamefamily 巡检:- 复核
docs/zh-CN/game/config-system.md - 复核
docs/zh-CN/game/scene.md - 复核
docs/zh-CN/game/ui.md - 复核
docs/zh-CN/source-generators/index.md
- 复核
- 对照
GFramework.Game、GFramework.Game.Abstractions、GFramework.Game.SourceGeneratorsREADME 与相关源码 / 测试后,未发现需要立刻修正的采用语义回漂 - 重点确认的真实语义包括:
GameConfigBootstrap/RegisterAllGeneratedConfigTables(...)/GFrameworkConfigSchemaDirectory的配置入口仍与文档示例一致SceneRouterBase仍通过SemaphoreSlim串行化切换,并拒绝重复sceneKey入栈UiRouterBase仍将Page层与Overlay/Modal/Toast/Topmost分为两套入口,且Show(..., UiLayer.Page)会直接拒绝
当前决策(RP-007)
- 本轮不为“巡检通过”硬造文档改动,先把结论写回 active topic,保持恢复点准确
Gamefamily 暂时转入稳定巡检,不在没有源码变化的情况下重复改写 landing page- 默认下一步切到
Godotfamily 摘要是否回迁,减少长期治理对 archive topic 的依赖
当前验证(RP-007)
- 构建校验:
cd docs && bun run build:通过;仅保留 VitePress 大 chunk warning,无构建失败
下一步
- 评估是否需要把
Godotfamily 的关键 XML inventory 摘要迁回 active topic - 若不需要迁回,则继续抽查 README / landing page / API reference 之间的 cross-link 是否出现新的漂移
当前恢复点:RP-008
- 使用
$gframework-pr-review抓取当前分支 PR#271后,确认 latest head review threads 仍有4条 open:docs/zh-CN/source-generators/cqrs-handler-registry-generator.md的 marker 类型约定说明缺口docs/zh-CN/ecs/index.md的边界说明语序问题docs/zh-CN/abstractions/ecs-arch-abstractions.md误放的 source-generator 内部模块提醒ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md的验证历史过长,以及ai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md缺少显式结果态
- 在当前 WSL 会话里,
gframework-pr-review脚本先命中了git.exe的Exec format error - 已将
.agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py改为优先使用 Linuxgit的显式--git-dir/--work-tree绑定,并仅在无法建立该绑定时回退到旧的可执行解析逻辑 - 已同步更新
.agents/skills/gframework-pr-review/SKILL.md,使其 Git 策略与命令示例都与当前仓库状态一致 - 已把
DOCUMENTATION-FULL-COVERAGE-GOV-RP-001到RP-007的详细验证历史迁入ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-through-rp-007.md
当前决策(RP-008)
- 继续把 latest-head unresolved threads 作为主信号,只修仍在本地成立的评论,不为已失效的历史 summary 做无意义回写
- active tracking 只保留最新验证摘要与恢复点;详细验证历史留在 topic 自己的 archive,而不是继续堆在默认 boot 路径
gframework-pr-review的脚本行为、技能文案与AGENTS.md必须保持同一套 WSL Git 策略,避免再次出现“文档说法正确但工具实现仍跑偏”的情况
当前验证(RP-008)
- PR review 抓取:
python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/gframework-current-pr-review.json:通过
- 脚本语法校验:
python3 -B -c "from pathlib import Path; compile(Path('.agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py').read_text(encoding='utf-8'), '.agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py', 'exec')":通过
- 文档校验:
validate-all.sh docs/zh-CN/source-generators/cqrs-handler-registry-generator.md:通过validate-all.sh docs/zh-CN/ecs/index.md:通过validate-all.sh docs/zh-CN/abstractions/ecs-arch-abstractions.md:通过
- 构建校验:
cd docs && bun run build:通过;仅保留既有 VitePress 大 chunk warning,无构建失败
下一步
- 提交本轮 PR review follow-up
- 推送当前分支后重新执行
$gframework-pr-review,观察 PR #271 的 open threads 是否收敛
当前恢复点:RP-009
- 按
boot恢复documentation-full-coverage-governance主题 - 重新读取
AGENTS.md、.ai/environment/tools.ai.yaml、ai-plan/public/README.md与当前 topic 的 active todo / trace 后,确认当前 worktreedocs/sdk-update-documentation仍映射到本 topic - 当前 worktree Git 状态干净,且不存在
ai-plan/private/的 worktree 私有恢复材料 - 重新执行
python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/gframework-current-pr-review.json - 抓取结果显示 PR
#271已关闭,latest reviewed commit 仍为df91d3706ba9db71737e803ef2f40f4841ecbbf1 - 当前 latest commit 仍显示
2条 open thread,但两条都落在ai-plan文件上,且本地文件已经满足评论要求:ai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md已包含显式结果:通过ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md已将 RP-001 至 RP-007 的详细验证明细迁入 archive
- 因此本轮将 PR #271 follow-up 视为已完成,后续不再为 closed PR 上未自动收敛的陈旧 thread 状态追加仓库改动
当前决策(RP-009)
closed PR + stale open thread不再作为需要继续修改仓库内容的信号;除非后续 review 抓取显示新的 latest-head findingdocumentation-full-coverage-governance的默认下一步切回治理 backlog,优先判断是否把Godotfamily 的关键 XML inventory 摘要迁回 active topic- 本轮
boot不引入 subagent;关键恢复信号都能通过本地读取和单次 PR review 抓取直接确认
当前验证(RP-009)
- PR review 抓取:
python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/gframework-current-pr-review.json:通过;PR#271已关闭,latest reviewed commit 为df91d3706ba9db71737e803ef2f40f4841ecbbf1,当前2条 open thread 都是已被本地文件满足的陈旧信号
- 构建校验:
cd docs && bun run build:通过;仅保留既有 VitePress 大 chunk warning,无构建失败
下一步
- 评估是否需要把
Godotfamily 的关键 XML inventory 摘要迁回 active topic - 若不迁回,则在 active todo / trace 保留足够的 archive 指针,并继续抽查 README / landing page / API reference 的 cross-link 是否出现新的漂移
当前恢复点:RP-010
- 按
boot恢复当前 topic 后,重新读取:AGENTS.md.ai/environment/tools.ai.yamlai-plan/public/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.mdai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
- 确认当前任务状态属于
resume:- 当前分支仍为
docs/sdk-update-documentation ai-plan/public/README.md继续把本 worktree 映射到documentation-full-coverage-governance- 当前 worktree 没有
ai-plan/private/私有恢复材料
- 当前分支仍为
- 为判断
Godotfamily 是否需要回填恢复摘要,补读归档主题:ai-plan/public/archive/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.mdai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.mdai-plan/public/archive/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md
- 归档材料表明,
Godotfamily 的可恢复关键信号已经稳定,且足以压缩成 active topic 里的最小摘要:- 核心页面集为
docs/zh-CN/godot/index.md、architecture.md、scene.md、ui.md、signal.md、extensions.md、logging.md与docs/zh-CN/tutorials/godot-integration.md GFramework.Godot.SourceGenerators继续作为[GetNode]、[BindNodeSignal]、AutoLoads、InputActions的 ownerGFramework.Godot.SourceGenerators.Abstractions继续按IsPackable=false的内部支撑模块处理GodotSceneFactory在 provider 缺失时回退到SceneBehaviorFactory,而GodotUiFactory仍要求IUiPageBehaviorProvider
- 核心页面集为
- 因此本轮决定:
- 不把整段
documentation-governance-and-refresh历史重新迁回 active 路径 - 只把足够让未来
boot快速恢复的Godotfamily 摘要写回 active todo - 继续把阶段级细节留在 archive,保持默认恢复入口轻量
- 不把整段
当前决策(RP-010)
Godotfamily 的“最小恢复摘要”应当留在 active topic,因为它已经属于长期治理 backlog 的默认上下文,而不仅仅是已完成项目的历史注脚- active topic 只保留对后续判断有用的事实:
- 页面范围
- generator owner
- Scene / UI 真实运行时边界
- archive 指针
documentation-governance-and-refresharchive 继续作为阶段级历史证据,不重新回到boot默认扫描路径- 下一步从“是否回填摘要”切换回“继续巡检 cross-link 漂移”,避免治理入口停留在已经完成的元问题上
当前验证(RP-010)
- 归档恢复检查:
sed -n '1,260p' ai-plan/public/archive/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md:通过sed -n '1,260p' ai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md:通过sed -n '1,240p' ai-plan/public/archive/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md:通过
下一步
- 抽查
Godot与Game相关 README / landing page / API reference 的 cross-link 是否出现新的漂移 - 当后续分支修改相关 README / docs / 公共 API 时,回到对应 module family 追加 targeted 巡检与验证
当前恢复点:RP-011
- 继续按
boot恢复后的默认下一步执行Godot/Gamecross-link 巡检,并额外补读:GFramework.Godot/README.mdGFramework.Godot.SourceGenerators/README.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/godot/index.mddocs/zh-CN/source-generators/index.md
- 结合
GFramework.Godot.csproj、GFramework.Godot.SourceGenerators.csproj、相关测试与scan_module_evidence.py输出,确认新的漂移点集中在入口 README:GFramework.Godot/README.md仍是旧版简略说明,没有记录当前包关系、子系统地图、最小接入路径与docs/zh-CN入口GFramework.Godot.SourceGenerators/README.md没有覆盖AutoScene、AutoUiPage、AutoRegisterExportedCollections这些当前已发布的生成器分组docs/zh-CN/api-reference/index.md的Godot映射仍只把生成器入口落到泛化总览页,恢复效率偏低
- 因此本轮执行最小修复集:
- 重写
GFramework.Godot/README.md - 重写
GFramework.Godot.SourceGenerators/README.md - 更新
docs/zh-CN/api-reference/index.md的Godot行
- 重写
当前决策(RP-011)
- 这轮不改
docs/zh-CN/godot/**landing / topic 页面,因为站内页面本身没有发现新的事实漂移,问题集中在仓库 README 与 API 入口的回退 GFramework.GodotREADME 必须和Game/Godot真实边界一致,明确它不是生成器 owner,也不引入虚构的 router 类型GFramework.Godot.SourceGeneratorsREADME 采用“元数据 / 节点注入与信号绑定 / 行为包装 / 批量注册”四段式入口,避免读者只看到旧的三项能力- API 参考页对
Godot生成器入口直接给出专题页链接,而不是仅要求读者再从总览页二次分流
当前验证(RP-011)
- 模块扫描:
python3 .agents/skills/gframework-doc-refresh/scripts/scan_module_evidence.py Godot:通过python3 .agents/skills/gframework-doc-refresh/scripts/scan_module_evidence.py Godot.SourceGenerators:通过
- 文档校验:
bash .agents/skills/gframework-doc-refresh/scripts/validate-links.sh GFramework.Godot/README.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh GFramework.Godot/README.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-links.sh GFramework.Godot.SourceGenerators/README.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh GFramework.Godot.SourceGenerators/README.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/api-reference/index.md:通过
- 构建校验:
cd docs && bun run build:通过;仅保留既有 VitePress 大 chunk warning,无构建失败
下一步
- 继续抽查根
README.md、docs/zh-CN/source-generators/index.md与docs/zh-CN/tutorials/godot-integration.md是否仍把Godotowner 写回旧边界 - 当后续分支继续修改
Game/Godotfamily 入口时,沿用当前 README -> landing -> API reference 的最小修复顺序
当前恢复点:RP-012
- 继续按
boot恢复后的默认下一步执行Game/Godot入口巡检,并重新读取:README.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/api-reference/index.mdGFramework.Godot/README.mdGFramework.Godot.SourceGenerators/README.md
- 巡检结果显示主体内容仍然稳定,但根入口摘要存在一处残留漂移:
- 根
README.md仍把GFramework.Godot.SourceGenerators写成“Godot 场景专用源码生成器”,与当前包实际覆盖的project.godot元数据、节点注入、信号绑定、Scene / UI 包装和导出集合注册职责不符 docs/zh-CN/source-generators/index.md的选包描述同步缺少 Scene / UI 包装与导出集合注册辅助这组能力
- 根
- 因此本轮执行最小修复集:
- 更新根
README.md的GFramework.Godot.SourceGenerators模块描述 - 更新
docs/zh-CN/source-generators/index.md的 Godot 选包摘要
- 更新根
当前决策(RP-012)
- 继续维持“只修新发现的入口漂移,不重写稳定页面”的治理节奏;这轮不改
docs/zh-CN/tutorials/godot-integration.md,因为教程与 README / 生成器专题页仍使用同一套职责边界 - 根
README.md作为仓库一级入口,必须与模块 README 保持同一粒度的职责摘要;如果根入口比模块 README 更旧,后续boot和人工恢复都会被误导 source-generators/index.md的选包段落需要覆盖当前真实能力分组,但不重复展开各专题页细节,避免重新长成第二份 README
当前验证(RP-012)
- 文档校验:
bash .agents/skills/gframework-doc-refresh/scripts/validate-links.sh README.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh README.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/index.md:通过
- 构建校验:
cd docs && bun run build:通过;仅保留既有 VitePress 大 chunk warning,无构建失败
下一步
- 继续抽查
docs/zh-CN/tutorials/godot-integration.md、docs/zh-CN/godot/index.md与根README.md的职责摘要是否继续保持同一口径 - 当后续分支继续修改
Game/Godotfamily 入口时,沿用当前 README -> landing -> API reference 的最小修复顺序
当前恢复点:RP-013
- 使用
$gframework-boot恢复当前 worktree 后,按documentation-full-coverage-governance的默认下一步执行一次 validation-only 巡检,并补读:README.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/api-reference/index.mdGFramework.Godot/README.md.agents/skills/gframework-doc-refresh/SKILL.md
- 同时执行
python3 .agents/skills/gframework-doc-refresh/scripts/scan_module_evidence.py Godot,确认当前Godotdocs surface 除index.md、architecture.md、scene.md、ui.md、signal.md、extensions.md、logging.md外,还应把storage.md与setting.md视为默认恢复集合的一部分 - 巡检结论:
- 根
README.md、docs/zh-CN/godot/index.md、docs/zh-CN/tutorials/godot-integration.md、docs/zh-CN/source-generators/index.md与docs/zh-CN/api-reference/index.md当前仍保持同一套Godotowner / adoption path 叙述,没有发现新的入口漂移 - 本轮不需要改动稳定的 README / docs 页面,只需要把 active topic 的最小恢复摘要补齐到当前 landing page 实际覆盖的页集合
- 根
- 因此本轮执行的唯一修改是:
- 更新
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md的恢复点、Godot页面集合、稳定性巡检结论与下一步 - 记录本条
RP-013trace,保证未来boot不会漏掉storage.md/setting.md
- 更新
当前决策(RP-013)
- 当前 topic 继续保持“巡检优先、最小修复”的节奏;验证通过时不为凑改动而重写稳定页面
scan_module_evidence.py识别出的 docs surface 应优先反映到 active recovery artifact,而不是只留在一次性 chat 上下文Godotfamily 的后续巡检重点从“根入口是否还残留旧描述”切换为“storage / setting 子页是否和 landing / README 保持同一口径”
当前验证(RP-013)
- 模块扫描:
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/index.md:通过bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/tutorials/godot-integration.md:通过
- 构建校验:
cd docs && bun run build:通过;仅保留既有 VitePress 大 chunk warning,无构建失败
下一步
- 若后续分支继续调整
GFramework.Godot运行时入口,优先复核docs/zh-CN/godot/storage.md、setting.md与根README.md/ landing page 是否仍保持同一套职责边界 - 当后续分支再修改
Godot/Gamefamily 的 README、docs 或公共 API 时,回到对应模块追加 targeted 巡检与验证