mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-13 22:25:37 +08:00
- 重写 Godot 集成教程,按当前源码与 CoreGrid 采用路径收口 project.godot、GetNode 与 BindNodeSignal 的接线说明 - 更新 tutorials 入口摘要与 documentation-governance-and-refresh 跟踪,记录 RP-013、验证结果和下一恢复点
6.3 KiB
6.3 KiB
Documentation Governance And Refresh Trace
2026-04-22
当前恢复点:RP-013
- 本轮从 PR #268 的最新 review 数据恢复,未发现失败检查;CTRF 报告显示 2139 个测试全部通过
- 本轮复核确认当前 PR 的 latest-head open thread 同时来自
coderabbitai[bot]与greptile-apps[bot] - 已本地修复仍然成立的 review:
docs/zh-CN/game/scene.md把“推荐目录与文件约定(项目侧)”降为“最小接入路径”下的子节docs/zh-CN/game/ui.md为“最小接入路径”补充导语,并修复同级标题错位.agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh改成 opening / closing fence 状态机.agents/skills/_shared/module-config.sh补齐缺失模块映射,并让未映射模块返回非零退出码
gframework-pr-review已从文案和输出模型两侧补齐多 reviewer 支持:当前 JSON 会单独给出review_agents以及open_thread_counts_by_user,文本输出会显式列出 CodeRabbit / Greptilefetch_current_pr_review.py的本地函数 docstring 覆盖率已补到44/44- 已闭环 RP-001 到 RP-008 的执行细节已归档到
ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-rp-001-through-rp-008.md - 本轮按
gframework-doc-refresh的模块扫描结果,重写了Godot.SourceGenerators的 3 个高风险专题页:godot-project-generator.mdget-node-generator.mdbind-node-signal-generator.md
- 新页面统一收口到“包关系、最小接入路径、真实生成语义、生命周期边界、诊断约束”,不再沿用旧教程式长篇 API 罗列
- 本轮额外复核了
ai-libs/CoreGrid的真实采用方式,确认[GetNode]/[BindNodeSignal]组合使用时应先注入节点再绑定事件 - 本轮继续收口
auto-register-exported-collections-generator.md,补齐 frontmatter,并把“导出集合”纠正为“实例可读集合成员 + registry 成员 + 单参数实例方法”的真实契约 - 本轮已重写
docs/zh-CN/tutorials/godot-integration.md,把内容收口为“包关系、project.godot接线、[GetNode]/[BindNodeSignal]协作顺序、运行时扩展边界、迁移提醒”,不再把旧 Godot API 列表当事实来源 docs/zh-CN/tutorials/index.md的 Godot 教程入口摘要已同步改成当前采用路径,避免入口页继续把教程描述成对象池 / 性能优化总览- 本轮检索确认 Godot 栏目仍有下一批高风险页面:
docs/zh-CN/godot/index.md与docs/zh-CN/godot/architecture.md还保留GetNodeX、CreateSignalBuilder、InstallGodotModule(...).Wait()等旧叙述,应作为 tutorial 之后的下一轮收口对象
当前决策
- active trace 只保留当前恢复点、关键事实、验证和下一步;完成阶段继续进入
archive/traces/ scene.md与ui.md的集成说明除目录布局外,也要保证标题层级能真实反映采用路径语义gframework-pr-review继续以 latest-head unresolved thread 为主信号,同时显式声明支持的 AI reviewer 名单,避免 skill 声明与实际抓取能力再次漂移Godot.SourceGenerators专题页继续采用“源码 / 测试 / README 优先,ai-libs/只补消费者 wiring”的证据顺序BindNodeSignal页面明确记录“当前不自动生成_Ready()/_ExitTree()”,避免继续把它写成自动生命周期织入器auto-register-exported-collections页面明确区分“运行时 null 时跳过注册”和“配置错误时编译期报错”,避免旧文档把两类边界混为一谈godot-integration.md已重新成为可用的采用路径入口;后续 Godot 文档收口应优先处理godot/index.md和godot/architecture.mddocs/zh-CN/godot/index.md若继续保留旧写法,会重新把 tutorial 已清掉的旧接入路径带回导航入口,因此优先级高于继续扩展新教程
验证
python3 -B .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --branch docs/sdk-update-documentation --format json --json-output /tmp/current-pr-review.jsonpython3 -B .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --branch docs/sdk-update-documentation --section open-threadspython3 -B -c "import ast, pathlib; path=pathlib.Path('.agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py'); tree=ast.parse(path.read_text(encoding='utf-8')); funcs=[node for node in ast.walk(tree) if isinstance(node,(ast.FunctionDef, ast.AsyncFunctionDef))]; documented=sum(1 for node in funcs if ast.get_docstring(node)); print(f'functions={len(funcs)} documented={documented} coverage={documented/len(funcs):.2%}')"bash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh docs/zh-CN/game/scene.mdbash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh docs/zh-CN/game/ui.mdbash -lc 'source .agents/skills/_shared/module-config.sh && get_readme_paths Core.SourceGenerators.Abstractions && if get_readme_paths Not.Real.Module; then exit 1; else echo unmapped-ok; fi'cd docs && bun run buildbash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/godot-project-generator.mdbash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/get-node-generator.mdbash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/bind-node-signal-generator.mdbash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/source-generators/auto-register-exported-collections-generator.mdcd docs && bun run buildbash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/tutorials/godot-integration.mdcd docs && bun run buildrg -n "GetNodeX|CreateSignalBuilder|GodotGameArchitecture|AbstractGodotModule|InstallGodotModule\(|GFramework\\.Godot\\.Pool" docs/zh-CN/godot docs/zh-CN/tutorials -S
下一步
- 优先重写
docs/zh-CN/godot/index.md,清掉GetNodeX、CreateSignalBuilder、InstallGodotModule(...)默认化叙述 - 视
godot/index.md收口结果,决定是否同步压缩docs/zh-CN/godot/architecture.md - 下一次推送后重新执行
$gframework-pr-review,确认 PR #268 的 CodeRabbit / Greptile open thread 是否关闭或减少