Docs/sdk update documentation#296
Conversation
- 更新安装页的选包矩阵、推荐组合与 Godot 基线说明 - 收口公开 README 的 XML 阅读入口表述，移除治理式计数与日期字段 - 调整配置系统与基础教程入口的 reader-facing 文案，并同步更新恢复文档
- 更新文档治理 tracking 的 branch diff 指标与当前工作树状态 - 补充本轮提交后的下一步恢复建议
- 更新入口页的 reader-facing 骨架，统一起步路线、阅读顺序与站内导航 - 收口公开 README 与 Godot 页面中的内部口吻、文件名式表述和术语噪音 - 移除 docs/zh-CN 中残留的 GitHub README 外链，并同步刷新文档治理恢复状态
- 更新 Godot 与教程细页的 reader-facing 采用说明 - 修复旧文档、ai-libs 与内部术语在公开页面中的暴露 - 更新文档治理恢复点并记录接近阈值的停止状态
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthrough本PR更新了GFramework框架文档体系，将多个模块README的XML覆盖基线表及日期标记改为简化的阅读重点引导，同时统一将外部GitHub README链接替换为内部文档链接，并移除特定的ai-libs参考示例，改为通用表述。 Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Test Results
Details
Insights
build-and-test: Run #989
🎉 All tests passed!Slowest Tests
± Comparison with run #981 at 743651d | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 33 runs. Github Test Reporter by CTRF 💚 |
|
| Filename | Overview |
|---|---|
| docs/zh-CN/getting-started/installation.md | Expands package table with Core.Abstractions, Game.Abstractions, Ecs.Arch, and Ecs.Arch.Abstractions; adds "推荐组合" section; changes Godot version requirement from ">= 4.5" to a fixed "4.6.2 基线" which may be ambiguous for users on earlier 4.x releases |
| docs/zh-CN/getting-started/index.md | Replaces external GitHub README blob links with internal doc links; restructures navigation into goal-oriented sections; adds links to installation.md, config-system.md, and Godot integration page |
| docs/zh-CN/source-generators/index.md | Converts bullet-list package selection into a table with "继续阅读" columns; moves shared-support-module section after the main selection table; replaces GitHub blob links with internal page links |
| GFramework.Game/README.md | Removes ai-libs references and duplicate Storage/ReadMe.md link; replaces internal "ai-libs/" attribution with generic "常见接法" phrasing; section retitled from ai-libs reference to generic layering guidance |
| GFramework.Core.Abstractions/README.md | Rewrites XML entry table to drop date stamp and coverage counts; adds "阅读重点" column with semantic guidance replacing the numeric baselines |
| docs/zh-CN/api-reference/index.md | Replaces GitHub blob README links in the module-mapping table with internal doc links; simplifies the "共享支撑层" section; removes the "当前以源码为准" disclaimer |
| docs/zh-CN/godot/scene.md | Removes CoreGrid-specific namespace from code sample, replacing with generic "GameProject.Scene"; replaces "旧文档" comparisons and ai-libs references with neutral current-API phrasing |
| docs/zh-CN/godot/ui.md | Replaces CoreGrid-specific namespace in code example with "GameProject.UI"; removes ai-libs/CoreGrid attribution from router description; terminology changed from "router" to "路由器" for consistency |
| ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md | Internal AI-plan tracking file updated with new recovery point and per-commit change log entries for this PR; not reader-facing content |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[入门指南\ngetting-started/index.md] --> B[安装配置\ninstallation.md]
A --> C[快速开始\nquick-start.md]
B --> D[Core 运行时\ncore/index.md]
B --> E[CQRS 运行时\ncore/cqrs.md]
B --> F[Game 模块总览\ngame/index.md]
B --> G[Godot 模块总览\ngodot/index.md]
B --> H[Arch ECS\necs/arch.md]
D --> I[Core 抽象层说明\nabstractions/core-abstractions.md]
F --> J[Game 抽象层说明\nabstractions/game-abstractions.md]
F --> K[配置系统\ngame/config-system.md]
G --> L[Godot 集成教程\ntutorials/godot-integration.md]
E --> M[源码生成器总览\nsource-generators/index.md]
M --> N[Core SG\nCore.SourceGenerators]
M --> O[Game SG\nGame.SourceGenerators]
M --> P[CQRS SG\nCqrs.SourceGenerators]
M --> Q[Godot SG\nGodot.SourceGenerators]
Prompt To Fix All With AI
This is a comment left during a code review.
Path: docs/zh-CN/getting-started/installation.md
Line: 244
Comment:
**Version requirement phrasing change may confuse users on 4.5–4.6.1**
The previous wording (`Godot 版本 >= 4.5`) communicated a clear minimum version. The new phrasing (`项目环境与当前文档保持在 Godot 4.6.2 基线`) is ambiguous: it reads as "stay at the 4.6.2 baseline", which users on 4.5.x or 4.6.0/4.6.1 could interpret as meaning their environment is unsupported. If earlier 4.x releases still work, consider phrasing that preserves the minimum-version signal, for example: `Godot 版本 >= 4.6.2（当前文档基线）`.
How can I resolve this? If you propose a fix, please make it concise.Reviews (2): Last reviewed commit: "docs(pr-review): 收口当前文档审查意见" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
✅MegaLinter analysis: Success
See detailed reports in MegaLinter artifacts
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/zh-CN/godot/extensions.md (1)
15-15: 可选改进：减少自我指涉表述。"这页的重点是识别..." 包含了对页面本身的引用。根据编码规范，公开文档应避免自我指涉的表述。建议直接陈述内容要点，而非描述页面本身。
♻️ 建议的改写方式
-这页的重点是识别这些扩展各自解决什么问题，以及哪些能力属于单一运行时辅助，而不是统一入口。 +以下内容说明这些扩展各自解决什么问题，以及哪些能力属于单一运行时辅助，而不是统一入口。或者更简洁：
-这页的重点是识别这些扩展各自解决什么问题，以及哪些能力属于单一运行时辅助，而不是统一入口。 +本文档说明这些扩展各自解决什么问题，以及哪些能力属于单一运行时辅助，而不是统一入口。As per coding guidelines: Public documentation MUST avoid rhetorical, self-referential, or AI-sounding headings and prompts; prefer neutral labels like '公开入口'、'模块与包关系'、'栏目覆盖范围' and '相关主题'.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-CN/godot/extensions.md` at line 15, Replace the self-referential sentence "这页的重点是识别这些扩展各自解决什么问题，以及哪些能力属于单一运行时辅助，而不是统一入口。" with a neutral, content-focused heading or summary (e.g., "栏目覆盖范围：识别扩展解决的问题及运行时职责" or "模块与包关系：区分单一运行时辅助与统一入口的能力") so the document states the content directly without referring to the page itself; update the header or paragraph containing that exact sentence accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/zh-CN/tutorials/godot-integration.md`:
- Line 68: Replace the phrase "更稳的默认接入方式" (exact text at Line 68) with a more
natural, professional alternative such as "更稳妥的默认接入方式" or "当前更稳定的默认接入方式" in the
document; update the sentence around that phrase in
docs/zh-CN/tutorials/godot-integration.md (look for the string "更稳的默认接入方式") so
the wording reads smoothly and consistently with the surrounding tutorial tone.
In `@GFramework.Game.SourceGenerators/README.md`:
- Around line 51-54: Rename the reader-facing labels in the README table from
filesystem path names to semantic titles: replace the "Config/" row label with a
meaningful title like "Schema → Configuration Codegen" (or similar) while
keeping SchemaConfigGenerator as the referenced generator, and replace
"Diagnostics/" with a semantic label like "Schema Diagnostics" while keeping
ConfigSchemaDiagnostics as the referenced diagnostics class; update the
third-column descriptions to remain accurate and ensure links (if any) still
point to SchemaConfigGenerator and ConfigSchemaDiagnostics so the documentation
uses semantic section titles instead of raw filenames.
In `@GFramework.Game/README.md`:
- Line 124: 删除 README.md 中重复的存储系统链接；在 GFramework.Game/README.md 中查找两个都指向
"../docs/zh-CN/game/storage.md" 的条目并移除其中一个，保留一个描述最准确的条目（确保保留的条目文本如 "存储系统专题"
或更明确的标题），保存并验证目录导航不会出现重复项。
---
Nitpick comments:
In `@docs/zh-CN/godot/extensions.md`:
- Line 15: Replace the self-referential sentence
"这页的重点是识别这些扩展各自解决什么问题，以及哪些能力属于单一运行时辅助，而不是统一入口。" with a neutral, content-focused
heading or summary (e.g., "栏目覆盖范围：识别扩展解决的问题及运行时职责" or
"模块与包关系：区分单一运行时辅助与统一入口的能力") so the document states the content directly without
referring to the page itself; update the header or paragraph containing that
exact sentence accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 607ad7b3-523a-46b7-9e2f-65ca5aab8bfc
📒 Files selected for processing (46)
GFramework.Core.Abstractions/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Ecs.Arch.Abstractions/README.mdGFramework.Ecs.Arch/README.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdGFramework.Godot/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.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/core/architecture.mddocs/zh-CN/core/cqrs.mddocs/zh-CN/core/index.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/game/config-system.mddocs/zh-CN/game/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/game/serialization.mddocs/zh-CN/game/setting.mddocs/zh-CN/game/ui.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/quick-start.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/godot/index.mddocs/zh-CN/godot/logging.mddocs/zh-CN/godot/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/godot/signal.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/ui.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/tutorials/index.md
📜 Review details
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Build and Test
- GitHub Check: Code Quality & Security
- GitHub Check: Analyze (C#)
🧰 Additional context used
📓 Path-based instructions (7)
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
Files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/game/serialization.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/core/architecture.mddocs/zh-CN/godot/signal.mddocs/zh-CN/game/config-system.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/game/setting.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/godot/ui.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/godot/scene.md
{README.md,docs/**}
📄 CodeRabbit inference engine (AGENTS.md)
{README.md,docs/**}: Update the relevantREADME.mdordocs/page when behavior, setup steps, architecture guidance, or user-facing examples change
Public documentation MUST NOT include governance-only content such as inventory tables, coverage baselines, review queues, batch metrics, recovery points, trace summaries, or 'this still needs a later audit wave' notes
Public documentation MUST use semantic section titles and link labels; do not surface raw filenames or paths as reader-facing navigation text when a meaningful destination label is available
Public documentation MUST avoid rhetorical, self-referential, or AI-sounding headings and prompts; prefer neutral labels like '公开入口'、'模块与包关系'、'栏目覆盖范围' and '相关主题'
Public documentation MUST present limitations, suitability, and migration boundaries as adoption guidance; do not publish internal-governance or product-roadmap wording
Keep code samples, package names, and command examples aligned with the current repository state in documentation
Prefer documenting behavior and design intent, not only API surface in user documentation
When a public page references XML docs or API coverage, convert that evidence into reader-facing guidance by explaining which types/namespaces/entry points readers should inspect and why, instead of exposing audit counts or governance terminology
If an existing documentation page no longer reflects the current implementation, fixing the code without fixing the documentation is considered incomplete work
Do not rely on 'the code is self-explanatory' for framework features that consumers need to adopt; write the adoption path down so future users do not need to rediscover it from source
When examples are rewritten, preserve only the parts that remain true; delete or replace speculative examples instead of lightly editing them into another inaccurate form
Files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/game/serialization.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/core/architecture.mddocs/zh-CN/godot/signal.mddocs/zh-CN/game/config-system.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/game/setting.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/godot/ui.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/godot/scene.md
docs/zh-CN/**
📄 CodeRabbit inference engine (AGENTS.md)
docs/zh-CN/**: When a feature is added, removed, renamed, or substantially refactored, contributors MUST update or create the corresponding user-facing integration documentation indocs/zh-CN/in the same change
For integration-oriented features such as the AI-First config system, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes
Files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/game/serialization.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/core/architecture.mddocs/zh-CN/godot/signal.mddocs/zh-CN/game/config-system.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/game/setting.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/godot/ui.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/godot/scene.md
docs/**
📄 CodeRabbit inference engine (AGENTS.md)
If a docs category appears in VitePress navigation or sidebar, it MUST have a real landing page or be removed from navigation in the same change
Files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/game/serialization.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/core/architecture.mddocs/zh-CN/godot/signal.mddocs/zh-CN/game/config-system.mddocs/zh-CN/tutorials/godot-integration.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/game/setting.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/godot/ui.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/godot/scene.md
**/README.md
📄 CodeRabbit inference engine (AGENTS.md)
**/README.md: Use the canonical filenameREADME.mdfor module documentation; do not introduce variants likeReadMe.md
A module README MUST describe: the module's purpose, relationship to adjacent runtime/abstractions/generator packages, major subdirectories or subsystems, minimum adoption path, and correspondingdocs/zh-CN/entry points
If a module's responsibilities, setup, public API surface, generator inputs, or adoption path change, update that module'sREADME.mdin the same change
Files:
GFramework.Ecs.Arch/README.mdGFramework.Game.SourceGenerators/README.mdGFramework.Ecs.Arch.Abstractions/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Godot/README.mdGFramework.Core.Abstractions/README.mdGFramework.Game.Abstractions/README.mdGFramework.Game/README.md
ai-plan/public/*/traces/**
📄 CodeRabbit inference engine (AGENTS.md)
Contributors MUST maintain a matching execution trace under
ai-plan/public/<topic>/traces/for complex work, recording the current date, key decisions, validation milestones, and the immediate next step
Files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
ai-plan/public/*/todos/**
📄 CodeRabbit inference engine (AGENTS.md)
ai-plan/public/*/todos/**: When working from a tracked implementation plan, contributors MUST update the corresponding tracking document underai-plan/public/<topic>/todos/in the same change
Tracking updates MUST reflect completed work, newly discovered issues, validation results, and the next recommended recovery point
Active tracking and trace files are recovery entrypoints, not append-only changelogs; they MUST stay concise enough forbootto locate the current recovery point quickly
Recovery documents MUST record the current phase, the active recovery point identifier, known risks, and the next recommended resume step so another contributor or subagent can continue the work safely
When completed and validated stages begin to accumulate, contributors MUST archive their detailed history out of the activetodos/andtraces/entry files in the same change, keeping only the current recovery point, active facts, active risks, immediate next step, and pointers to archive files
When a task spans multiple commits or is likely to exceed a single agent context window, update both the recovery document and the trace at each meaningful milestone before pausing or handing work off
If subagents are used on a complex task, the main agent MUST capture the delegated scope and any accepted findings in the active recovery document or trace before continuing implementation
Files:
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
🧠 Learnings (36)
📓 Common learnings
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to docs/zh-CN/** : 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
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to docs/zh-CN/** : For integration-oriented features such as the AI-First config system, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST avoid rhetorical, self-referential, or AI-sounding headings and prompts; prefer neutral labels like '公开入口'、'模块与包关系'、'栏目覆盖范围' and '相关主题'
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/README.md : A module README MUST describe: the module's purpose, relationship to adjacent runtime/abstractions/generator packages, major subdirectories or subsystems, minimum adoption path, and corresponding `docs/zh-CN/` entry points
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/README.md : If a module's responsibilities, setup, public API surface, generator inputs, or adoption path change, update that module's `README.md` in the same change
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Update the relevant `README.md` or `docs/` page when behavior, setup steps, architecture guidance, or user-facing examples change
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to docs/zh-CN/** : For integration-oriented features such as the AI-First config system, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes
Applied to files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/game/serialization.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mdGFramework.Ecs.Arch/README.mdGFramework.Game.SourceGenerators/README.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/core/architecture.mddocs/zh-CN/game/config-system.mdGFramework.Godot/README.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/game/setting.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mddocs/zh-CN/godot/scene.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to docs/zh-CN/** : 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
Applied to files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/game/serialization.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mdGFramework.Game.SourceGenerators/README.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mddocs/zh-CN/core/architecture.mddocs/zh-CN/game/config-system.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/game/setting.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/README.md : A module README MUST describe: the module's purpose, relationship to adjacent runtime/abstractions/generator packages, major subdirectories or subsystems, minimum adoption path, and corresponding `docs/zh-CN/` entry points
Applied to files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mdGFramework.Ecs.Arch/README.mdGFramework.Game.SourceGenerators/README.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/core/cqrs.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/godot/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mdGFramework.Godot/README.mddocs/zh-CN/source-generators/godot-project-generator.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/godot/architecture.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST avoid rhetorical, self-referential, or AI-sounding headings and prompts; prefer neutral labels like '公开入口'、'模块与包关系'、'栏目覆盖范围' and '相关主题'
Applied to files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/godot/storage.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/core/cqrs.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mdGFramework.Godot/README.mddocs/zh-CN/source-generators/godot-project-generator.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 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/getting-started/quick-start.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/logging.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/auto-register-exported-collections-generator.mddocs/zh-CN/source-generators/context-aware-generator.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/game/ui.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/godot/index.mddocs/zh-CN/tutorials/basic/index.mddocs/zh-CN/game/scene.mddocs/zh-CN/godot/setting.mdGFramework.Godot/README.mddocs/zh-CN/source-generators/godot-project-generator.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/game/index.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Update the relevant `README.md` or `docs/` page when behavior, setup steps, architecture guidance, or user-facing examples change
Applied to files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/abstractions/ecs-arch-abstractions.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/game/ui.mddocs/zh-CN/core/cqrs.mdGFramework.Core.Abstractions/README.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/README.md : If a module's responsibilities, setup, public API surface, generator inputs, or adoption path change, update that module's `README.md` in the same change
Applied to files:
docs/zh-CN/getting-started/quick-start.mddocs/zh-CN/source-generators/get-node-generator.mddocs/zh-CN/source-generators/priority-generator.mddocs/zh-CN/source-generators/bind-node-signal-generator.mddocs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/context-aware-generator.mdGFramework.Game.SourceGenerators/README.mddocs/zh-CN/core/cqrs.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/godot/index.mdGFramework.Godot/README.mddocs/zh-CN/source-generators/godot-project-generator.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/godot/architecture.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/source-generators/index.mddocs/zh-CN/getting-started/installation.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdGFramework.Game/README.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : When a public page references XML docs or API coverage, convert that evidence into reader-facing guidance by explaining which types/namespaces/entry points readers should inspect and why, instead of exposing audit counts or governance terminology
Applied to files:
docs/zh-CN/abstractions/core-abstractions.mddocs/zh-CN/source-generators/context-aware-generator.mdGFramework.Game.SourceGenerators/README.mddocs/zh-CN/core/cqrs.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/source-generators/godot-project-generator.mdGFramework.Core.Abstractions/README.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/core/index.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/api-reference/index.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST present limitations, suitability, and migration boundaries as adoption guidance; do not publish internal-governance or product-roadmap wording
Applied to files:
docs/zh-CN/abstractions/core-abstractions.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST use semantic section titles and link labels; do not surface raw filenames or paths as reader-facing navigation text when a meaningful destination label is available
Applied to files:
docs/zh-CN/abstractions/core-abstractions.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/*.cs : Any change to public API, lifecycle semantics, module behavior, or extension points MUST update the related XML docs
Applied to files:
GFramework.Game.SourceGenerators/README.mddocs/zh-CN/godot/extensions.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/godot/index.mddocs/zh-CN/core/architecture.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/api-reference/index.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/*.cs : All public, protected, and internal types and members MUST include XML documentation comments (`///`) with `<summary>`, `<param>`, `<returns>`, `<exception>`, and `<remarks>` where applicable
Applied to files:
GFramework.Game.SourceGenerators/README.mdGFramework.Core.Abstractions/README.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/*.cs : Core framework components such as Architecture, Module, System, Context, Registry, Service Module, and Lifecycle types MUST include high-level explanations of responsibilities, lifecycle, interactions, why the abstraction exists, and when to use it
Applied to files:
GFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/core/architecture.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/core/index.md
📚 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: Component coordination should use separate components (ArchitectureLifecycle, ArchitectureComponentRegistry, ArchitectureModules) to distribute responsibilities rather than concentrating them in a single core class
Applied to files:
docs/zh-CN/godot/index.md
📚 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: Lifecycle management in Architecture implementations should handle Init, Ready, and Destroy phases with fine-grained initialization and destruction stages to maintain order consistency across Utility, Model, System, service modules, and hooks
Applied to files:
docs/zh-CN/core/architecture.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/*.cs : If a framework abstraction changes meaning or intended usage, update the explanatory comments in code as part of the same change
Applied to files:
GFramework.Cqrs.Abstractions/README.mdGFramework.Core.Abstractions/README.md
📚 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 **/*Abstractions/**/*.cs : Abstractions projects should only contain interfaces and contract definitions without any runtime implementation logic
Applied to files:
GFramework.Cqrs.Abstractions/README.md
📚 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 **/Cqrs/**/*.cs : Use CQRS (Command Query Responsibility Segregation) pattern with the Cqrs naming entry point instead of the historical Mediator alias
Applied to files:
GFramework.Cqrs.Abstractions/README.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST NOT include governance-only content such as inventory tables, coverage baselines, review queues, batch metrics, recovery points, trace summaries, or 'this still needs a later audit wave' notes
Applied to files:
GFramework.Core.Abstractions/README.mdai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/README.md : When a worktree-to-topic mapping changes, or when a topic becomes active/inactive, contributors MUST update `ai-plan/public/README.md` in the same change
Applied to files:
GFramework.Game.Abstractions/README.mdGFramework.Game/README.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to {README.md,docs/**} : Do not rely on 'the code is self-explanatory' for framework features that consumers need to adopt; write the adoption path down so future users do not need to rediscover it from source
Applied to files:
GFramework.Game.Abstractions/README.mddocs/zh-CN/getting-started/index.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to **/*.cs : When generator behavior changes intentionally, update snapshots together with the implementation
Applied to files:
docs/zh-CN/source-generators/index.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/traces/** : Contributors MUST maintain a matching execution trace under `ai-plan/public/<topic>/traces/` for complex work, recording the current date, key decisions, validation milestones, and the immediate next step
Applied to files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/todos/** : Tracking updates MUST reflect completed work, newly discovered issues, validation results, and the next recommended recovery point
Applied to files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/todos/** : Active tracking and trace files are recovery entrypoints, not append-only changelogs; they MUST stay concise enough for `boot` to locate the current recovery point quickly
Applied to files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/todos/** : When a task spans multiple commits or is likely to exceed a single agent context window, update both the recovery document and the trace at each meaningful milestone before pausing or handing work off
Applied to files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/todos/** : When completed and validated stages begin to accumulate, contributors MUST archive their detailed history out of the active `todos/` and `traces/` entry files in the same change, keeping only the current recovery point, active facts, active risks, immediate next step, and pointers to archive files
Applied to files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Governance-only material such as XML audit snapshots, documentation remediation baselines, backlog status, and recovery metadata belongs in `ai-plan/**`, not in public docs
Applied to files:
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-06T12:45:47.739Z
Learnt from: GeWuYou
Repo: GeWuYou/GFramework PR: 190
File: GFramework.Game/Config/GameConfigBootstrap.cs:1-3
Timestamp: 2026-04-06T12:45:47.739Z
Learning: In the GFramework repository (GeWuYou/GFramework), even though `ImplicitUsings` is disabled in the `.csproj` files, the project uses a manual `GlobalUsings.cs` file with `global using` directives to provide common System namespaces (e.g., System, System.Threading, System.Threading.Tasks) project-wide. Do not flag missing System-level `using` imports in C# files within this repository, as they are covered by GlobalUsings.cs.
Applied to files:
docs/zh-CN/getting-started/installation.md
📚 Learning: 2026-04-16T13:26:01.780Z
Learnt from: GeWuYou
Repo: GeWuYou/GFramework PR: 235
File: GFramework.SourceGenerators.Tests/Rule/ContextAwareGeneratorSnapshotTests.cs:1-3
Timestamp: 2026-04-16T13:26:01.780Z
Learning: In the GeWuYou/GFramework repository, the test project `GFramework.SourceGenerators.Tests` provides `global using NUnit.Framework;` via its `GlobalUsings.cs`. Do not flag missing `using NUnit.Framework;` directives in test files within this project, as the global using already covers it. The project-wide GlobalUsings.cs pattern is used broadly to supply common namespaces (including NUnit, System.IO, etc.) without per-file imports.
Applied to files:
docs/zh-CN/getting-started/installation.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Treat `ai-libs/` as a read-only third-party source reference area; code under `ai-libs/**` exists for comparison, tracing, design study, and behavior verification
Applied to files:
GFramework.Game/README.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: When implementation plans, traces, reviews, or design notes reference a third-party project, prefer the repository-local path under `ai-libs/` instead of an unspecified upstream repository
Applied to files:
GFramework.Game/README.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: For any multi-step refactor, migration, or cross-module task, contributors MUST create or adopt a dedicated recovery document under `ai-plan/public/<topic>/todos/` before making substantive code changes
Applied to files:
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/todos/** : When working from a tracked implementation plan, contributors MUST update the corresponding tracking document under `ai-plan/public/<topic>/todos/` in the same change
Applied to files:
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-26T03:16:48.230Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-26T03:16:48.230Z
Learning: Applies to ai-plan/public/*/todos/** : Recovery documents MUST record the current phase, the active recovery point identifier, known risks, and the next recommended resume step so another contributor or subagent can continue the work safely
Applied to files:
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
🪛 LanguageTool
docs/zh-CN/tutorials/godot-integration.md
[uncategorized] ~68-~68: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：稳"地"默认
Context: ...个文件名识别输入。 ## 第二步：把架构和 Godot 节点分开看 当前更稳的默认接入方式，是： - 架构层继续用常规 `InstallModule(new...
(wb4)
docs/zh-CN/source-generators/index.md
[grammar] ~29-~29: Ensure spelling is correct
Context: ...S handler registry 在编译期生成，缩小运行时反射扫描范围 | GeWuYou.GFramework.Cqrs.SourceGenerators | [CQRS 运行时](../core/...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/zh-CN/getting-started/installation.md
[grammar] ~20-~20: Ensure spelling is correct
Context: ...CQRS runtime | 命令 / 查询 / 通知分发与处理器注册 | | GeWuYou.GFramework.Cqrs.Abstractions | CQRS 抽象契约 | 共享 request、...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~29-~29: Ensure spelling is correct
Context: ...| Godot 源码生成器 | Godot 节点、UI、项目元数据生成 | | GeWuYou.GFramework.Cqrs.SourceGenerators | CQRS 源码生成器 | 处理器注册表...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/zh-CN/api-reference/index.md
[style] ~35-~35: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d) | Arch ECS 集成、[Ecs.Arch 抽象层说明](../abstractions/ecs-arch-abstrac...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/zh-CN/godot/scene.md
[uncategorized] ~70-~70: 您的意思是“"不"项目”？
Context: ...ot runtime 确实能“自动给节点补一个 behavior”，但它不会替你补项目侧路由器、root 或 registry。 ## 最小接入路径 推荐按下...
(BU)
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
[grammar] ~38-~38: Ensure spelling is correct
Context: ...README.md、GFramework.Godot/README.md、GFramework.Cqrs.Abstractions/README.md、GFramework.Ecs...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (65)
docs/zh-CN/godot/extensions.md (1)
169-169: 边界说明准确。这条边界说明清晰地指出了当前
NodeExtensions不提供的 API，有助于用户理解扩展的职责范围，符合采用指导的要求。docs/zh-CN/game/setting.md (1)
19-19: 表述更新方向正确，语义更清晰。两处改写都更贴近读者可执行的接入语义，且与当前初始化/迁移实现一致。
Also applies to: 94-94
docs/zh-CN/tutorials/index.md (1)
42-42: 受众描述改写合理。“接入边界的开发者”比原表述更直接、面向落地场景。
docs/zh-CN/godot/architecture.md (1)
3-3: 生命周期与接入建议表述更一致。这组改写把“异步挂接路径优先”的边界讲清楚了，方向正确。
Also applies to: 37-37, 98-98, 150-150
docs/zh-CN/game/config-system.md (1)
1024-1024: 工具形态建议的语气更稳健。从“能力缺口”转为“采用门槛/角色分工”判断，读者导向更明确。
Also applies to: 1028-1028
ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md (1)
3-107: trace 记录完整，满足恢复要求。新增恢复点内容包含决策、验证与结果，作为恢复入口可用性良好。
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md (1)
15-22: tracking 更新结构化且可恢复。恢复点、状态、验证结果与下一步都已同步，符合 active tracking 文档用途。
Also applies to: 34-40, 83-142, 229-234
GFramework.Ecs.Arch/README.md (1)
3-3: 模块定位描述更精确。“Arch ECS 集成的默认运行时实现包”比原描述更明确。
GFramework.Ecs.Arch.Abstractions/README.md (1)
40-44: 表格改动方向正确，保留了读者导向信息。本次将状态列收敛为“阅读重点”，可读性更好，也更符合模块 README 的导航用途。
GFramework.Cqrs.Abstractions/README.md (1)
3-3: 术语与边界描述和代码实现一致。
ICqrsContext的 marker 定位及IContextAware需IArchitectureContext的约束表达准确，避免误导接入方。Also applies to: 46-46, 96-96
GFramework.Godot/README.md (1)
122-122: 接入边界表述更清晰，文档可执行性更好。“宿主实现 ≠ Game 默认行为”的提醒和“典型接入方式”标题都很到位。
Also applies to: 128-130, 134-134
GFramework.Core.Abstractions/README.md (1)
39-39: 目录视图改写合理，保持了“读什么/为何读”的导向。该段已经从“覆盖/基线”转为“阅读重点”，符合抽象层文档定位。
Also applies to: 41-49
GFramework.Game.Abstractions/README.md (1)
28-28: 分层职责与阅读顺序表达清楚，改动有效。这一版更聚焦“契约边界 + 典型落地分层”，对消费者更友好。
Also applies to: 135-135, 137-144, 211-213
docs/zh-CN/tutorials/godot-integration.md (1)
198-198: 术语收敛到当前入口，迁移指引更明确。这两处改写有助于减少旧入口心智负担，方向正确。
Also applies to: 229-229
docs/zh-CN/source-generators/get-node-generator.md (1)
218-218: 链接替换正确，站内导航一致性提升。将外链替换为站内入口后，阅读路径更连贯。
docs/zh-CN/getting-started/quick-start.md (1)
110-110: 导航链接更新恰当。将外部 GitHub README 链接替换为内部文档链接
./installation.md，符合统一导航规范，改善了用户阅读体验。docs/zh-CN/source-generators/priority-generator.md (1)
216-216: 链接重构符合内部导航标准。将推荐阅读中的外部 GitHub 链接替换为源码生成器总览页面 (
./index.md)，使导航保持在文档站点内部，提升了阅读连贯性。docs/zh-CN/source-generators/context-aware-generator.md (1)
198-198: 导航链接统一化处理正确。与其他源码生成器文档保持一致，将推荐阅读指向内部总览页，符合文档导航规范。
docs/zh-CN/source-generators/bind-node-signal-generator.md (1)
192-192: 跨模块导航链接更新合理。将 Godot 源码生成器相关链接指向 Godot 模块总览页面，建立了清晰的模块间导航路径。
docs/zh-CN/abstractions/core-abstractions.md (1)
100-102: 阅读顺序重构提升了文档可导航性。将外部 GitHub README 引用替换为结构化的内部文档导航路径，引导读者从抽象层理解逐步过渡到运行时实现和入门指南，符合用户学习路径。
docs/zh-CN/ecs/arch.md (1)
143-143: 增加入门指南链接改善了模块导航。在相关入口中补充入门指南链接，为 ECS 模块使用者提供了统一的起步路径，与其他模块文档保持一致。
docs/zh-CN/core/cqrs.md (1)
217-217: CQRS 文档导航链接更新适当。将继续阅读指向统一的入门指南页面，该页面已覆盖 CQRS 请求流的选包与接入顺序说明，符合文档导航一致性要求。
docs/zh-CN/source-generators/auto-register-exported-collections-generator.md (1)
223-223: Godot 模块导航链接更新保持一致性。与其他 Godot 相关源码生成器文档保持相同的导航模式，统一指向 Godot 模块总览页，建立了清晰的文档导航体系。
docs/zh-CN/game/serialization.md (1)
49-49: 文档措辞改进，直接引导读者关注核心要点。将原来可能存在的通用警告替换为具体的阅读指导，符合编码规范要求：避免在公开文档中暴露"文档可能过时"等治理性提示，改为直接的用户导向指引。
docs/zh-CN/abstractions/game-abstractions.md (1)
119-121: 统一文档导航，改用站内链接。将外部 GitHub README 引用替换为内部文档页面链接，提升阅读体验的连贯性。目标页面（Game 模块总览、入门指南）已在相关代码片段中确认存在。
docs/zh-CN/source-generators/godot-project-generator.md (1)
220-220: 推荐阅读链接改为站内文档。与 PR 整体方向一致，将 Godot 源码生成器的外部 GitHub 引用替换为内部模块总览页面，保持文档导航的统一性。
docs/zh-CN/abstractions/ecs-arch-abstractions.md (1)
92-94: ECS 抽象层文档导航统一化。与 Game 抽象层文档的调整保持一致，改用内部 ECS 模块总览和入门指南链接，替代原有的外部 GitHub README 引用。
docs/zh-CN/godot/storage.md (1)
63-63: 移除项目特定引用，改用通用表述。将
ai-libs/CoreGrid的具体实现引用改为"当前更常见的接法"，使文档更具通用性和适用性，符合 PR 目标。docs/zh-CN/game/scene.md (1)
261-262: 场景系统文档推荐阅读更新。替换为内部文档链接（Game 抽象层说明、API 参考），与 UI 系统文档的更新保持一致。
docs/zh-CN/game/ui.md (1)
332-333: UI 系统文档推荐阅读更新。与场景系统文档同步更新，统一使用内部文档导航链接，提升 Game 模块文档的一致性。
docs/zh-CN/godot/setting.md (2)
75-75: 统一接入路径表述。与 Godot 存储系统文档保持一致，使用"当前更常见的接法"这一通用表述，移除特定项目引用。
103-103: 术语标准化。将 "family 入口" 改为 "模块入口"，使用更规范的中文技术文档术语，符合编码规范对中性标签的要求。
docs/zh-CN/core/architecture.md (1)
64-80: 文档准确反映了当前实现。这段描述正确指出了
OnInitialize()是当前架构的注册入口，并为旧代码提供了迁移指导。与提供的代码片段 (GFramework.Core/Architectures/Architecture.cs:280-340) 一致，Architecture确实定义了protected abstract OnInitialize()方法作为用户自定义初始化的入口点。docs/zh-CN/tutorials/basic/index.md (1)
163-165: 措辞改进使文档更加专业。将快速开始路径的描述从"只想看最终结果"等非正式表述改为"查看完整架构示例"等中性语言，符合公共文档应避免修辞性、自我指涉标题的编码规范。As per coding guidelines: "Public documentation MUST avoid rhetorical, self-referential, or AI-sounding headings and prompts."
docs/zh-CN/godot/logging.md (1)
70-71: 文档接入路径更加通用。将 Godot 日志 provider 的接线说明从特定项目示例改为通用的
ArchitectureConfiguration.LoggerProperties模式，使文档更适合公共消费。这与 PR 目标一致，即用内部文档链接和通用表述替换外部ai-libs/CoreGrid引用。docs/zh-CN/godot/signal.md (1)
107-108: 内部文档引用更加合理。将交叉引用从外部 README 改为内部
../source-generators/index.md，并使用语义化链接标签"源码生成器总览"，符合文档导航的最佳实践。As per coding guidelines: "Public documentation MUST use semantic section titles and link labels; do not surface raw filenames or paths as reader-facing navigation text."docs/zh-CN/godot/ui.md (2)
3-19: 术语标准化改进文档一致性。在描述、概述和类型列表中统一使用"路由器"术语，提高了文档的专业性和可读性。这与 PR 在 Godot 文档中的广泛术语清理工作一致。
86-108: 路由器示例适当通用化。将路由器示例从特定项目引用改为通用的
GameProject.UI命名空间，并使用"最小形态"描述方式，使文档更适合公共消费。示例仍保留了完整的集成结构（UiRouter : UiRouterBase及处理器注册），符合集成文档必须涵盖项目接线的要求。Based on learnings: "For integration-oriented features, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example."docs/zh-CN/godot/index.md (2)
63-64: 架构集成指导采用通用模式。将架构接入说明从特定项目示例改为描述当前稳定方法（继承
AbstractArchitecture，使用InstallModule(...)），使新用户能够获得适用于一般场景的集成指导，而非依赖特定项目实现。
153-153: API 边界说明更加简洁。移除与旧版
CreateSignalBuilder(...)的比较，只关注当前的Signal(...)fluent API 入口，使文档更加清晰且避免混淆。这符合文档应关注当前实现而非历史演进的原则。docs/zh-CN/godot/scene.md (3)
3-17: 场景系统描述更加中立准确。更新了描述以强调 GFramework.Godot 将 Game 场景契约适配到 PackedScene，并统一使用"路由器"术语，移除了与"Godot 专用路由器"的对比，使文档更加中立和专业。
42-43: 源码路径描述更加客观。将"旧文档必须有..."的对比表述改为"当前源码允许两条路径"的中性陈述，使文档更加客观、关注当前实现，而非与历史文档对比。
76-104: 场景路由器示例适当通用化。将路由器示例从特定项目改为通用的
GameProject.Scene命名空间，保留了完整的集成结构（registry 注入、handler 注册、scene transition），为用户提供了可复用的最小接入模式。Based on learnings: "For integration-oriented features, documentation MUST cover: required project or package wiring, minimal working usage example."docs/zh-CN/getting-started/installation.md (5)
8-29: 包选择表完整涵盖了运行时与抽象层。扩展的包清单采用了一致的"运行时 + 抽象契约"模式，新增的 ECS Arch 包条目与现有模块（Core、CQRS、Game）的组织方式保持一致，使用户能够清晰理解各层依赖边界。
40-48: 推荐组合引导新用户选择合适的包。新增的"推荐组合"部分为不同场景（最小运行时、CQRS、Game 配置、Godot、ECS）提供了清晰的包选择指导，并链接到相关集成文档，符合集成导向特性的文档必须涵盖项目接线和最小工作示例的要求。Based on learnings: "For integration-oriented features, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example."
67-69: ECS 包安装示例结构合理。CLI 安装命令涵盖了 ECS Arch 运行时和抽象层两个包，与文档其他部分的包组织模式一致。示例使用的包名遵循
GeWuYou.GFramework.Ecs.Arch[.Abstractions]命名约定。
169-170: 命名空间排除示例更加具体。更新的
GFrameworkExcludedUsing示例使用了具体的框架命名空间（GFramework.Core.Environment、GFramework.Godot.Extensions），比之前更有针对性，帮助用户理解如何选择性排除自动导入。
247-247: Godot 版本基线更新为 4.6.2。文档将 Godot 环境要求从 ">= 4.5" 更新为具体的 "Godot 4.6.2 基线"，提供了更明确的版本要求。这有助于用户确保环境兼容性。
docs/zh-CN/getting-started/index.md (1)
8-119: 文档导航重构完成得很好。这次更新成功将入口页从"三问式检查清单"转换为以目标为导向的导航页，并且：
- 所有外部 GitHub README 链接已替换为内部文档链接（如
./installation.md、../game/config-system.md、../tutorials/godot-integration.md）- 移除了治理性质的内容，改用面向读者的阅读引导
- 章节标题采用了中性、语义化的表达（如"适合谁先读本栏"、"按目标选择起步路线"）
- 为每个起步路线提供了明确的后续阅读入口
这些改动符合编码指南中关于公开文档应避免治理术语、使用内部导航链接、以及提供语义化章节标题的要求。
docs/zh-CN/core/index.md (4)
11-11: 定位说明改进得当。将定位从"入口导航 vs 旧教程镜像"调整为"先确认 Core 解决什么问题、最小安装组合是什么，再决定什么时候转向其他模块"，更符合首次接入用户的实际需求，避免了内部治理视角的表述。
35-35: 导航意图表述清晰。从"入口导航 vs 完整目录阅读"转换为"按能力域选择页面"，为读者提供了更实用的阅读策略。
74-74: XML 阅读入口引导规范。Line 74 成功将 XML 覆盖证据转换为读者导向的阅读路径："先读本页与 Core 抽象层说明，确认运行时和契约层边界"，符合编码指南中"将 XML 文档覆盖转换为读者导向引导"的要求。
151-155: 模块入口链接已正确内部化。"对应模块入口"部分成功移除了所有外部 GitHub README 引用，全部替换为内部文档链接：
- 入门指南、Core 抽象层说明、CQRS 运行时、源码生成器总览均使用相对路径
- 符合编码指南中"使用内部文档导航而非 GitHub 引用"的要求
docs/zh-CN/game/index.md (3)
28-28: 导航目标简化得当。从特定的"source/ai-libs 验证事实"对齐引导转换为通用的"按目标选择运行时接入路径"，移除了项目内部治理引用，使文档更适合公开阅读。
118-124: 运行时与生成器关系说明更清晰。替换了之前关于配置组合、设置持久化仓库、路由工厂等的具体断言，改为通用的依赖检查清单，并增加了 VS Code 配置工具的引导，更符合面向读者的采用指南要求。
126-131: 模块入口链接已统一内部化。"对应模块入口"部分已全部更新为内部文档链接（入门指南、Game 抽象层说明、源码生成器总览、API 参考入口），与整个 PR 的导航重构方向保持一致。
docs/zh-CN/source-generators/index.md (4)
10-10: 入口定位精准。开篇明确"我该装哪个生成器包、它服务哪个运行时、接下来该去哪看示例或专题页"，直击首次接入者的核心疑问。
25-30: 场景选包表格重构优秀。从之前的场景-包列表转换为包含"继续阅读"列的表格，为每个使用场景提供了明确的后续文档入口：
- Core 侧样板代码 → 日志生成器、ContextAware 生成器
- Schema 配置生成 → 配置系统、VS Code 配置工具
- CQRS handler registry → CQRS 运行时、Handler Registry 生成器
- Godot 项目生成 → Godot 模块总览、项目生成器、GetNode 生成器
这种结构让读者可以直接从场景跳转到对应的专题页，显著提升了导航效率。
56-71: 共享支撑模块定位调整合理。将共享支撑目录（
SourceGenerators.Common、*.SourceGenerators.Abstractions）从"可安装包"重新定位为"排查生成失败时的下钻目标"，避免了读者误将这些内部支撑模块作为独立采用入口。更新后的引导逻辑更清晰：
- 先判断要装哪个
*.SourceGenerators包- 再根据 attribute 或 diagnostics 回到对应专题页
- 只有在排查生成失败时，才继续下钻到共享支撑目录
119-123: 模块入口链接已完成内部化。"对应模块入口"部分已全部更新为内部文档链接（Core 模块、Game 模块总览、CQRS 运行时、Godot 模块总览），与 PR 整体的导航重构策略一致。
docs/zh-CN/api-reference/index.md (5)
8-14: API 参考定位转换成功。从"签名索引"重新定位为"先看哪个模块入口、再回哪里读 XML 文档的导航页"，并提供了清晰的三步阅读顺序：
- 先按模块找到对应栏目入口
- 再进专题页确认安装、生命周期和推荐接线方式
- 最后回到源码中的 XML 文档核对具体契约
这种导航优先的方法更符合实际使用场景，避免了将 API 文档作为独立签名快照来维护。
20-24: 入口页引导简化有效。从之前的"四证据链"简化为"先读站内入口页"，移除了 GitHub README 验证步骤，直接引导读者到入门指南和安装配置页面。
29-35: 模块映射表升级优秀。更新后的表格提供了更精准的内部深链接：
Cqrs→ CQRS Handler Registry 生成器、协程系统Game→ 配置系统Godot→ 项目生成器、GetNode 生成器、BindNodeSignal 生成器Ecs.Arch→ Arch ECS 集成这种细粒度的链接让读者可以直接跳转到相关专题，而不是停留在模块总览层面。符合编码指南中"使用语义化目标标签而非原始文件路径"的要求。
63-69: 共享支撑层阅读路径调整合理。明确了
*.SourceGenerators.Abstractions和SourceGenerators.Common这些目录"当前不作为独立采用入口"，引导读者"优先回到所属模块页和 source-generators 栏目，再根据需要下钻到具体源码目录"。这种定位避免了读者误将内部支撑模块作为公开 API 入口。
77-82: 使用方式说明精炼准确。将本页定位为"API 阅读导航"而非"签名快照"，三步引导（选模块 → 进专题页确认采用路径 → 回 XML 文档核对契约）与页面开头的阅读顺序保持一致，形成完整的导航闭环。
- 更新 Game 与 SourceGenerators README 的公开入口命名和重复链接 - 优化 Godot 教程与扩展页的 reader-facing 措辞 - 补充 PR #296 的治理跟踪与验证记录
Summary
Test Results
Details
Insights
build-and-test: Run #990
🎉 All tests passed!Slowest Tests
± Comparison with run #989 at 285c009 | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 34 runs. Github Test Reporter by CTRF 💚 |
1 participant
Summary by CodeRabbit
发布说明