Docs/sdk update documentation by GeWuYou · Pull Request #270 · GeWuYou/GFramework

GeWuYou · 2026-04-22T05:34:59Z

Summary by CodeRabbit

文档更新

Documentation
- 重写 Godot 集成文档，聚焦当前实际功能与边界，移除过时内容和示例。
- 优化源代码生成器（GetNode、BindNodeSignal、AutoRegisterExportedCollections、GodotProject）文档，提高准确性与清晰度。
- 重组 Godot 集成教程，按实际项目集成路径调整结构，更新最小接入指引。
- 更新文档治理跟踪，反映 Godot 模块文档完善进度与验证步骤。

- 更新 Godot 项目元数据、GetNode 与 BindNodeSignal 专题页，按当前源码与测试收口最小接入路径、生成语义与诊断边界 - 补充 documentation-governance-and-refresh 的 RP-011 恢复点、验证结果与下一步建议

- 更新 auto-register-exported-collections 专题页，补齐 frontmatter 并按当前源码与测试收口成员形状、匹配规则、null-skip 行为与诊断边界 - 补充 documentation-governance-and-refresh 的 RP-012 恢复点，记录 godot-integration tutorial 仍残留旧 API 的跟进风险

- 重写 Godot 集成教程，按当前源码与 CoreGrid 采用路径收口 project.godot、GetNode 与 BindNodeSignal 的接线说明 - 更新 tutorials 入口摘要与 documentation-governance-and-refresh 跟踪，记录 RP-013、验证结果和下一恢复点

- 更新 Godot landing page，使包关系、最小接入路径与运行时边界回到源码与测试契约 - 重写 Godot architecture 页面，明确锚点生命周期、模块挂接顺序与 IGodotModule 契约边界 - 更新 documentation-governance topic 的 RP-014 跟踪与验证记录，标记下一轮收口目标

- 更新 Godot 场景文档，按当前 factory、registry、root、provider 与 AutoScene 接线收口采用路径 - 更新 Godot UI 文档，明确 layer 语义、provider 要求、root 接线与 AutoUiPage 用法 - 同步 documentation-governance-and-refresh 跟踪与 trace 到 RP-015，并把下一步切到 signal/extensions

- 更新 godot signal 页面，明确 Signal(...)、SignalBuilder 与 [BindNodeSignal] 的分工 - 更新 godot extensions 页面，收敛到当前存在的扩展成员与生命周期边界 - 补充 documentation-governance-and-refresh 跟踪与 trace，记录 RP-016 和验证结果

- 重写 docs/zh-CN/godot/logging.md，按当前 provider、控制台输出语义与 [Log] 边界整理采用路径 - 更新 documentation-governance-and-refresh 的 tracking 与 trace，推进恢复点到 RP-017 并记录验证结果

coderabbitai · 2026-04-22T05:35:07Z

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 532d434c-cf9d-401a-864e-54db515e24cc

📥 Commits

Reviewing files that changed from the base of the PR and between 3425b29 and 76e7f68.

📒 Files selected for processing (15)

ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md
ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md
docs/zh-CN/godot/architecture.md
docs/zh-CN/godot/extensions.md
docs/zh-CN/godot/index.md
docs/zh-CN/godot/logging.md
docs/zh-CN/godot/scene.md
docs/zh-CN/godot/signal.md
docs/zh-CN/godot/ui.md
docs/zh-CN/source-generators/auto-register-exported-collections-generator.md
docs/zh-CN/source-generators/bind-node-signal-generator.md
docs/zh-CN/source-generators/get-node-generator.md
docs/zh-CN/source-generators/godot-project-generator.md
docs/zh-CN/tutorials/godot-integration.md
docs/zh-CN/tutorials/index.md

📜 Recent review details

🧰 Additional context used

📓 Path-based instructions (5)

docs/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

Documentation should be organized with Chinese content in docs/zh-CN/ and structured to include getting started, module-specific capabilities (Core, Game, Godot, ECS), source generator usage, tutorials, best practices, and troubleshooting

Update the relevant README.md or docs/ page when behavior, setup steps, architecture guidance, or user-facing examples change. Keep code samples, package names, and command examples aligned with the current repository state. Prefer documenting behavior and design intent, not only API surface. If an existing documentation page no longer reflects the current implementation, fixing the code without fixing the documentation is considered incomplete work.

Files:

docs/zh-CN/tutorials/index.md
docs/zh-CN/source-generators/auto-register-exported-collections-generator.md
docs/zh-CN/source-generators/bind-node-signal-generator.md
docs/zh-CN/godot/architecture.md
docs/zh-CN/godot/signal.md
docs/zh-CN/godot/index.md
docs/zh-CN/godot/extensions.md
docs/zh-CN/source-generators/godot-project-generator.md
docs/zh-CN/godot/ui.md
docs/zh-CN/godot/logging.md
docs/zh-CN/source-generators/get-node-generator.md
docs/zh-CN/tutorials/godot-integration.md
docs/zh-CN/godot/scene.md

docs/zh-CN/**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

When a feature is added, removed, renamed, or substantially refactored, contributors MUST update or create the corresponding user-facing integration documentation in docs/zh-CN/ in the same change. For integration-oriented features, documentation MUST cover project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes when behavior changes.

Files:

docs/zh-CN/tutorials/index.md
docs/zh-CN/source-generators/auto-register-exported-collections-generator.md
docs/zh-CN/source-generators/bind-node-signal-generator.md
docs/zh-CN/godot/architecture.md
docs/zh-CN/godot/signal.md
docs/zh-CN/godot/index.md
docs/zh-CN/godot/extensions.md
docs/zh-CN/source-generators/godot-project-generator.md
docs/zh-CN/godot/ui.md
docs/zh-CN/godot/logging.md
docs/zh-CN/source-generators/get-node-generator.md
docs/zh-CN/tutorials/godot-integration.md
docs/zh-CN/godot/scene.md

ai-plan/public/**

📄 CodeRabbit inference engine (AGENTS.md)

Keep committed ai-plan/public/** content safe to publish in Git history. Never write secrets, tokens, credentials, private keys, machine usernames, home-directory paths, hostnames, IP addresses, proprietary URLs, or other sensitive environment details into any ai-plan/** file. Never record absolute file-system paths; use repository-relative paths, branch names, PR numbers, or stable document identifiers instead.

Files:

ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md
ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md

ai-plan/public/*/traces/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Maintain a matching execution trace under ai-plan/public/<topic>/traces/ for complex work. The trace should record the current date, key decisions, validation milestones, and the immediate next step. Update both the recovery document and the trace at each meaningful milestone before pausing or handing work off.

Files:

ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md

ai-plan/public/*/todos/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Contributors MUST keep ai-plan/public/<topic>/todos/ recovery documents up-to-date with completed work, newly discovered issues, validation results, and the next recommended recovery point. For any multi-step refactor, migration, or cross-module task, create or adopt a dedicated recovery document before making substantive code changes. Recovery documents MUST record the current phase, the active recovery point identifier, known risks, and the next recommended resume step.

Files:

ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md

🧠 Learnings (12)

📓 Common learnings

Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.762Z
Learning: Applies to docs/**/*.md : Documentation should be organized with Chinese content in docs/zh-CN/ and structured to include getting started, module-specific capabilities (Core, Game, Godot, ECS), source generator usage, tutorials, best practices, and troubleshooting

Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-22T03:16:51.907Z
Learning: Applies to docs/zh-CN/**/*.md : When a feature is added, removed, renamed, or substantially refactored, contributors MUST update or create the corresponding user-facing integration documentation in `docs/zh-CN/` in the same change. For integration-oriented features, documentation MUST cover project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes when behavior changes.

Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-22T03:16:51.907Z
Learning: Treat existing `README.md` files and `docs/zh-CN/` pages as editable outputs, not authoritative truth. If existing documentation conflicts with code or tests, update the documentation to match the implementation instead of preserving outdated wording. Do not publish example code, setup steps, or package guidance that cannot be traced back to code, tests, or a verified consumer project.

📚 Learning: 2026-04-17T11:35:08.762Z

Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.762Z
Learning: Applies to docs/**/*.md : Documentation should be organized with Chinese content in docs/zh-CN/ and structured to include getting started, module-specific capabilities (Core, Game, Godot, ECS), source generator usage, tutorials, best practices, and troubleshooting

Applied to files:

docs/zh-CN/tutorials/index.md
ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md
docs/zh-CN/godot/index.md
docs/zh-CN/godot/extensions.md
docs/zh-CN/source-generators/godot-project-generator.md
docs/zh-CN/godot/ui.md
docs/zh-CN/godot/logging.md
docs/zh-CN/source-generators/get-node-generator.md
docs/zh-CN/tutorials/godot-integration.md
ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md