Docs/sdk update documentation#290
Conversation
- 更新 docs 站点中 abstractions、source-generators、api-reference 的导航文案，使其与 landing page 入口一致 - 补充遗漏的源码生成器 sidebar 条目，并本地化抽象层与 API 参考的侧边栏标签 - 修复 ECS、Game、Godot 文档中的路径式可见链接标签，改为读者可理解的语义化名称
- 优化根 README、模块 README 与抽象层页面的 reader-facing 文案和语义化链接标签 - 补充 tutorials、troubleshooting、best-practices、contributing、godot/resource 的代码块语言标记 - 更新 documentation-full-coverage-governance 的恢复点、验证结果与批处理停止条件
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 43 minutes and 44 seconds. ⌛ 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)
📝 Walkthrough功能概览本 PR 对多个 README 文件进行了文档框架调整，将 "XML 覆盖基线" 重新表述为 "XML 阅读入口"，同时批量更新了 变更内容
代码审查工作量估算🎯 3 (中等) | ⏱️ ~25 分钟 可能相关的 PR
✨ 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 |
|
| Filename | Overview |
|---|---|
| docs/.vitepress/config.mts | Sidebar navigation updated: trailing slashes added to two nav links, new source-generator entries added (all target existing pages), Abstractions section gains a 概览 overview item. |
| GFramework.Core/README.md | Restructured XML coverage table from 基线状态 counters to 阅读重点 guidance; section heading renamed from XML 覆盖基线 to XML 阅读入口. |
| GFramework.Game/README.md | Same XML table restructuring as Core README; numeric coverage column removed in favour of 阅读重点 column. |
| GFramework.Game.SourceGenerators/README.md | Section heading and introductory text updated to frame the table as a navigational aid rather than a coverage inventory. |
| docs/zh-CN/troubleshooting.md | 18 fenced code blocks updated from bare totext for consistent syntax highlighting. |
| docs/zh-CN/abstractions/game-abstractions.md | Raw file-path link labels replaced with descriptive Chinese text for the reading-order section. |
| docs/zh-CN/tutorials/index.md | Learning-path code blocks updated from bare totext. |
| docs/zh-CN/tutorials/pause-system.md | Two code blocks updated to ```text; trailing blank line removed at end of file. |
| docs/zh-CN/tutorials/save-system.md | Two code blocks updated to ```text; missing newline at end of file added. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[VitePress Sidebar Nav] --> B[源码生成器 Section]
A --> C[抽象接口 Section]
A --> D[API 参考 Nav Link]
B --> B1[概览]
B --> B2[日志生成器]
B --> B3[枚举扩展生成器]
B --> B4[ContextAware 生成器]
B --> B5[Priority 生成器]
B --> B6[Context Get 注入生成器]
B --> B7[模块自动注册生成器 NEW]
B --> B8[CQRS Handler Registry 生成器]
B --> B9[Godot 项目元数据生成器]
B --> B10[GetNode 生成器]
B --> B11[BindNodeSignal 生成器]
B --> B12[AutoUiPage 生成器 NEW]
B --> B13[AutoScene 生成器 NEW]
B --> B14[AutoRegisterExportedCollections 生成器 NEW]
C --> C0[概览 NEW]
C --> C1[Core 抽象层说明]
C --> C2[Game 抽象层说明]
C --> C3[Ecs.Arch 抽象层说明]
D --> D1[trailing slash fixed]
Reviews (2): Last reviewed commit: "docs(pr-review): 收口文档审查反馈" | Re-trigger Greptile
Summary
Test Results
Details
Insights
build-and-test: Run #971
🎉 All tests passed!Slowest Tests
± Comparison with run #969 at 22d6471 | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 28 runs. Github Test Reporter by CTRF 💚 |
![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: 1
🧹 Nitpick comments (4)
docs/.vitepress/config.mts (1)
279-292: API 参考侧栏新增项与现有栏目导航重复，建议改为入口页内引导。新增
/zh-CN/api-reference/侧栏直接把 Core/Game/Godot/ECS/抽象接口/源码生成器的总览链接复制进来作为目录项；这些目标都是其他独立栏目的入口（已在顶部导航和各自侧栏暴露），在 API 参考侧栏里再列一遍会让读者从 API 参考点进去后跳出到完全不同的栏目，且左侧侧栏会随之切换为目标栏目自身的侧栏，体验割裂。如
docs/zh-CN/api-reference/index.md已经在做"按模块映射 README、专题页、教程链路"的引导，建议把这种跨栏目跳转留给 index 页内容，而不是放进侧栏目录树；侧栏只保留 API 参考自身的子页（若暂时没有，则不需要单独 sidebar 配置即可）。As per coding guidelines: "Prefer linking the root
README.mdto section landing pages such asindex.mdinstead of deep-linking to single articles when the target is a documentation category"（同样的"用 index 引导而非平铺导航"逻辑也适用于侧栏）。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/.vitepress/config.mts` around lines 279 - 292, The API reference sidebar (the '/zh-CN/api-reference/' array) currently duplicates top-level module links (Core, Game, Godot, ECS, 抽象接口, 源码生成器); remove these deep links from the '/zh-CN/api-reference/' sidebar and either leave only a single entry pointing to the API reference index (docs/zh-CN/api-reference/index.md) or remove the custom sidebar for '/zh-CN/api-reference/' so the index/README drives navigation; update the sidebar config around the '/zh-CN/api-reference/' key and ensure cross-category guidance remains in index.md rather than as sidebar items.GFramework.Game/README.md (1)
172-184: 与 Core/Ecs.Arch README 同样问题：表内仍保留覆盖基线列。标题与导语已重写为「XML 阅读入口」的读者视角，但表格仍以
26/26 个类型声明已带 XML 注释这种盘点数据作为「基线状态」列暴露在公开 README。这与本 PR 的整体改写意图相悖，且会随源码持续变更而陈旧。建议直接删除「基线状态」列，仅保留「子系统 / 代表类型 / 阅读重点」三列，既精简又稳定。另外 Line 174 的硬编码日期
2026-04-23同样建议去掉。As per coding guidelines: "Public documentation MUST stay reader-facing and not publish governance-only content such as inventory tables, coverage baselines, review queues, or audit notes".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@GFramework.Game/README.md` around lines 172 - 184, Remove the governance-only "基线状态" column and the hard-coded date from the README table: delete the "基线状态" header and its corresponding cells in every row so the table becomes "子系统 | 代表类型 | 阅读重点", and remove the literal date string "2026-04-23" from the intro sentence; update the table rows (e.g., those mentioning "26/26 个类型声明已带 XML 注释") to only include the subsystem, representative types (like YamlConfigLoader, DataRepository, SettingsModel<TRepository>, SceneRouterBase, DataLocationExtensions) and reading focus, ensuring the README remains reader-facing and stable.GFramework.Ecs.Arch/README.md (1)
122-131: 「XML 阅读入口」改写后，建议同步精简下表的「XML 状态」列。标题与引导段已从覆盖基线视角切换到「类型级 XML 文档入口」的阅读引导，但下表仍保留 "XML 状态 / 已覆盖" 这一治理/盘点风格的列。在新的读者视角下，这列信息既无差异（全部一致为"已覆盖"），又偏向内部审计语义，建议要么删除该列，要么改为更面向读者的字段（如"阅读重点"，与
GFramework.Game/README.md、GFramework.Game.Abstractions/README.md的表头保持一致）。As per coding guidelines: "Public documentation MUST stay reader-facing and not publish governance-only content such as inventory tables, coverage baselines, review queues, or audit notes".
♻️ 建议表头与 Game 系列 README 对齐
-| 类型族 | 代表类型 | XML 状态 | 阅读重点 | -| --- | --- | --- | --- | -| 装配入口 | `ArchExtensions` | 已覆盖 | `UseArch(...)` 的时机与返回值 | -| 运行时模块 | `ArchEcsModule` | 已覆盖 | `World` 注册、系统排序、销毁顺序 | -| 系统桥接层 | `ArchSystemAdapter<T>` | 已覆盖 | `OnArchInitialize`、`OnUpdate`、`OnArchDispose` | -| 示例类型 | `Position`、`Velocity`、`MovementSystem` | 已覆盖 | 组件布局、查询写法、最小示例 | +| 类型族 | 代表类型 | 阅读重点 | +| --- | --- | --- | +| 装配入口 | `ArchExtensions` | `UseArch(...)` 的时机与返回值 | +| 运行时模块 | `ArchEcsModule` | `World` 注册、系统排序、销毁顺序 | +| 系统桥接层 | `ArchSystemAdapter<T>` | `OnArchInitialize`、`OnUpdate`、`OnArchDispose` | +| 示例类型 | `Position`、`Velocity`、`MovementSystem` | 组件布局、查询写法、最小示例 |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@GFramework.Ecs.Arch/README.md` around lines 122 - 131, The README table still includes an internal "XML 状态" column with governance-style content; update the table in GFramework.Ecs.Arch README by removing the "XML 状态" column (or replacing it with a reader-facing column such as "用途" or expanding "阅读重点"), and align the table headers and intent with the Game-series READMEs (keep rows for the representative types like ArchExtensions, ArchEcsModule, ArchSystemAdapter<T>, Position/Velocity/MovementSystem and focus the remaining columns on reader-facing guidance such as "阅读重点" or "用途"). Ensure the displayed headers no longer contain audit/governance terminology and the text around the table reflects the "类型级 XML 文档入口" reader perspective.GFramework.Core/README.md (1)
63-77: 「XML 阅读入口」改写后，下表仍是覆盖基线/盘点表，与公开文档约束冲突。新的标题与导语已经把语义改为"类型级 XML 文档入口的目录视图"，但表中的「基线状态」列仍是
22/22 个类型声明已带 XML 注释这类 coverage/audit 数据，属于内部治理信息，对采用者并无价值，并会随源码漂移而陈旧。建议要么删除该列，要么按GFramework.Game/README.md、GFramework.Game.Abstractions/README.md的统一风格替换为「阅读重点」之类的读者面字段。另外 Line 65 的硬编码日期
2026-04-22与GFramework.Game/README.md的2026-04-23不一致，且这种"截至 X 日期已带 XML"的表述天然容易过期，建议一并去掉，让这个表只承担"读什么类型"的导航职责。As per coding guidelines: "Public documentation MUST stay reader-facing and not publish governance-only content such as inventory tables, coverage baselines, review queues, or audit notes".
♻️ 建议改造为纯阅读导航表
## XML 阅读入口 -截至 `2026-04-22`，下面这份目录视图可以帮助你快速定位 `GFramework.Core` 的类型级 XML 文档入口；当前主目录族的类型声明都已带 -XML 注释。更细的参数、返回值和生命周期语义，适合在阅读对应类型与成员时继续结合源码确认。 +下面这份目录视图按子系统列出 `GFramework.Core` 的类型级 XML 文档入口，帮助你确定阅读顺序。更细的参数、返回值和生命周期语义，建议继续回到具体类型与成员确认。 -| 类型族 | 基线状态 | 代表类型 | -| --- | --- | --- | -| `Architectures/` `Services/` | `22/22` 个类型声明已带 XML 注释 | `Architecture`、`ArchitectureContext`、`ArchitectureLifecycle`、`ServiceModuleManager` | -| `Command/` `Query/` | `15/15` 个类型声明已带 XML 注释 | `CommandExecutor`、`AsyncQueryExecutor`、`AbstractCommand<TInput>`、`AbstractQuery<TResult>` | +| 类型族 | 代表类型 | 阅读重点 | +| --- | --- | --- | +| `Architectures/` `Services/` | `Architecture`、`ArchitectureContext`、`ArchitectureLifecycle`、`ServiceModuleManager` | 架构入口、上下文与服务模块生命周期 | +| `Command/` `Query/` | `CommandExecutor`、`AsyncQueryExecutor`、`AbstractCommand<TInput>`、`AbstractQuery<TResult>` | 旧版命令/查询执行器与基类 | ...🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@GFramework.Core/README.md` around lines 63 - 77, The "XML 阅读入口" section currently mixes reader-facing navigation with internal governance data: remove the "基线状态" column (or replace it with a reader-facing column such as "阅读重点") from the table and eliminate the hardcoded date "2026-04-22" (Line 65) so the table only serves as a navigation list to type-level XML docs; keep the "类型族" and "代表类型" rows (e.g., Architecture, ArchitectureContext, CommandExecutor, AsyncQueryExecutor, EventBus, BindableProperty<T>, CoroutineScheduler, ResourceManager, ConsoleLogger, AbstractModel, Result<T>) and adjust the intro to describe the table as a directory for reading rather than a coverage baseline.
🤖 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/.vitepress/config.mts`:
- Around line 251-257: Sidebar labels '枚举生成器', 'ContextGet 生成器', and 'Godot
项目生成器' in the nav array should be aligned with the actual document
H1/frontmatter titles; update the entries in docs/.vitepress/config.mts (the
objects with text values '枚举生成器', 'ContextGet 生成器', 'Godot 项目生成器') to match the
corresponding document titles '枚举扩展生成器', 'Context Get 注入生成器', and 'Godot
项目元数据生成器' (or alternatively change those documents' H1/frontmatter to the
sidebar wording if you prefer the other option) so labels and targets are
consistent.
---
Nitpick comments:
In `@docs/.vitepress/config.mts`:
- Around line 279-292: The API reference sidebar (the '/zh-CN/api-reference/'
array) currently duplicates top-level module links (Core, Game, Godot, ECS,
抽象接口, 源码生成器); remove these deep links from the '/zh-CN/api-reference/' sidebar
and either leave only a single entry pointing to the API reference index
(docs/zh-CN/api-reference/index.md) or remove the custom sidebar for
'/zh-CN/api-reference/' so the index/README drives navigation; update the
sidebar config around the '/zh-CN/api-reference/' key and ensure cross-category
guidance remains in index.md rather than as sidebar items.
In `@GFramework.Core/README.md`:
- Around line 63-77: The "XML 阅读入口" section currently mixes reader-facing
navigation with internal governance data: remove the "基线状态" column (or replace
it with a reader-facing column such as "阅读重点") from the table and eliminate the
hardcoded date "2026-04-22" (Line 65) so the table only serves as a navigation
list to type-level XML docs; keep the "类型族" and "代表类型" rows (e.g., Architecture,
ArchitectureContext, CommandExecutor, AsyncQueryExecutor, EventBus,
BindableProperty<T>, CoroutineScheduler, ResourceManager, ConsoleLogger,
AbstractModel, Result<T>) and adjust the intro to describe the table as a
directory for reading rather than a coverage baseline.
In `@GFramework.Ecs.Arch/README.md`:
- Around line 122-131: The README table still includes an internal "XML 状态"
column with governance-style content; update the table in GFramework.Ecs.Arch
README by removing the "XML 状态" column (or replacing it with a reader-facing
column such as "用途" or expanding "阅读重点"), and align the table headers and intent
with the Game-series READMEs (keep rows for the representative types like
ArchExtensions, ArchEcsModule, ArchSystemAdapter<T>,
Position/Velocity/MovementSystem and focus the remaining columns on
reader-facing guidance such as "阅读重点" or "用途"). Ensure the displayed headers no
longer contain audit/governance terminology and the text around the table
reflects the "类型级 XML 文档入口" reader perspective.
In `@GFramework.Game/README.md`:
- Around line 172-184: Remove the governance-only "基线状态" column and the
hard-coded date from the README table: delete the "基线状态" header and its
corresponding cells in every row so the table becomes "子系统 | 代表类型 | 阅读重点", and
remove the literal date string "2026-04-23" from the intro sentence; update the
table rows (e.g., those mentioning "26/26 个类型声明已带 XML 注释") to only include the
subsystem, representative types (like YamlConfigLoader, DataRepository,
SettingsModel<TRepository>, SceneRouterBase, DataLocationExtensions) and reading
focus, ensuring the README remains reader-facing and stable.
🪄 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: df3fe6c8-4307-492f-88f3-36da87e560cf
📒 Files selected for processing (34)
GFramework.Core.Abstractions/README.mdGFramework.Core/README.mdGFramework.Ecs.Arch.Abstractions/README.mdGFramework.Ecs.Arch/README.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdREADME.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/.vitepress/config.mtsdocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/best-practices/architecture-patterns.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/contributing.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/game/serialization.mddocs/zh-CN/game/setting.mddocs/zh-CN/game/storage.mddocs/zh-CN/godot/resource.mddocs/zh-CN/godot/setting.mddocs/zh-CN/godot/storage.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/godot-complete-project.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/tutorials/pause-system.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/state-machine-tutorial.mddocs/zh-CN/tutorials/unit-testing.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: Analyze (C#)
- GitHub Check: Build and Test
- GitHub Check: Code Quality & Security
🧰 Additional context used
📓 Path-based instructions (10)
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/contributing.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/game/serialization.mddocs/zh-CN/tutorials/godot-complete-project.mddocs/zh-CN/game/setting.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/best-practices/architecture-patterns.mddocs/zh-CN/godot/setting.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/game/storage.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/state-machine-tutorial.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.md
{README.md,docs/**}
📄 CodeRabbit inference engine (AGENTS.md)
{README.md,docs/**}: Public documentation MUST stay reader-facing and not publish governance-only content such as inventory tables, coverage baselines, review queues, or audit notes
Public documentation MUST use semantic section titles and link labels without exposing raw filenames or paths
Public documentation MUST avoid rhetorical, self-referential, or AI-sounding headings and prompts, preferring neutral labels
Public documentation MUST present limitations, suitability, and migration boundaries as adoption guidance, not internal-governance or product-roadmap wording
Files:
docs/zh-CN/contributing.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/game/serialization.mddocs/zh-CN/tutorials/godot-complete-project.mddocs/zh-CN/game/setting.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/best-practices/architecture-patterns.mddocs/zh-CN/godot/setting.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/game/storage.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mdREADME.mddocs/zh-CN/tutorials/state-machine-tutorial.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.md
docs/**
📄 CodeRabbit inference engine (AGENTS.md)
docs/**: The main documentation site lives underdocs/with Chinese content underdocs/zh-CN/; keep code samples, package names, and command examples aligned with current repository state
Prefer documenting behavior and design intent, not only API surface, in documentation pages
For integration-oriented features such as AI-First config system, documentation MUST cover project directory layout, file conventions, required wiring, minimal working example, and migration notes
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
When examples are rewritten, preserve only the parts that remain true and delete or replace speculative examples instead of lightly editing them
Files:
docs/zh-CN/contributing.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/game/serialization.mddocs/zh-CN/tutorials/godot-complete-project.mddocs/zh-CN/game/setting.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/best-practices/architecture-patterns.mddocs/zh-CN/godot/setting.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/game/storage.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/state-machine-tutorial.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.md
docs/zh-CN/**
📄 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
Files:
docs/zh-CN/contributing.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/game/serialization.mddocs/zh-CN/tutorials/godot-complete-project.mddocs/zh-CN/game/setting.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/best-practices/architecture-patterns.mddocs/zh-CN/godot/setting.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/game/storage.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mddocs/zh-CN/tutorials/state-machine-tutorial.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.md
**/README.md
📄 CodeRabbit inference engine (AGENTS.md)
**/README.md: Use the canonical filenameREADME.md(notReadMe.mdor other variants) for module documentation
A module README MUST describe the module's purpose, relationship to adjacent packages, major subdirectories, minimum adoption path, and corresponding docs/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
Update the relevantREADME.mdordocs/page when behavior, setup steps, architecture guidance, or user-facing examples change
Files:
GFramework.Ecs.Arch.Abstractions/README.mdGFramework.Game/README.mdGFramework.Core/README.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.mdREADME.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.md
README.md
📄 CodeRabbit inference engine (AGENTS.md)
README.md: The repository rootREADME.mdMUST mirror the current top-level documentation taxonomy used by the docs site
Prefer linking the rootREADME.mdto section landing pages such asindex.mdinstead of deep-linking to single articles when the target is a documentation category
Files:
README.md
ai-plan/public/**
📄 CodeRabbit inference engine (AGENTS.md)
ai-plan/public/**: Contributors MUST keep committedai-plan/public/**content safe to publish in Git history and never write secrets, tokens, credentials, private keys, or sensitive environment details
Tracking updates MUST reflect completed work, newly discovered issues, validation results, and the next recommended recovery point
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/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
ai-plan/**
📄 CodeRabbit inference engine (AGENTS.md)
Never record absolute file-system paths in
ai-plan/**; use repository-relative paths, branch names, PR numbers, or stable document identifiers instead
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
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
For any multi-step refactor, migration, or cross-module task, contributors MUST create or adopt a dedicated recovery document underai-plan/public/<topic>/todos/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-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
🧠 Learnings (39)
📓 Common learnings
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
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
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: The commit `summary` MUST use simplified Chinese and briefly describe the main change
Applied to files:
docs/zh-CN/contributing.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/game/serialization.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mddocs/zh-CN/best-practices/architecture-patterns.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/game/storage.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mdREADME.mdGFramework.Game.Abstractions/README.mddocs/zh-CN/tutorials/state-machine-tutorial.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.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: The commit `body` MUST use unordered list items with each item starting with a verb such as 新增、修复、优化、更新、补充、重构
Applied to files:
docs/zh-CN/contributing.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.mddocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/pause-system.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Commit messages MUST use Conventional Commits format: `<type>(<scope>): <summary>`
Applied to files:
docs/zh-CN/contributing.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
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/contributing.mdGFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/game/serialization.mddocs/zh-CN/game/setting.mddocs/zh-CN/ecs/arch.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mddocs/zh-CN/best-practices/architecture-patterns.mddocs/zh-CN/godot/setting.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/game/storage.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mdREADME.mddocs/zh-CN/tutorials/state-machine-tutorial.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.mddocs/.vitepress/config.mtsdocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Each commit body bullet MUST describe one independent change point; avoid repeated or redundant descriptions
Applied to files:
docs/zh-CN/contributing.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Keep technical terms in English when they are established project terms such as API、Model、System in Chinese commit messages
Applied to files:
docs/zh-CN/contributing.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: The branch naming rule for a new task branch is `<type>/<topic-or-scope>`, where `<type>` should match the intended Conventional Commit category as closely as practical
Applied to files:
docs/zh-CN/contributing.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
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.Ecs.Arch.Abstractions/README.mddocs/zh-CN/best-practices/index.mdGFramework.Game/README.mdGFramework.Core/README.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to **/README.md : A module README MUST describe the module's purpose, relationship to adjacent packages, major subdirectories, minimum adoption path, and corresponding docs/zh-CN/ entry points
Applied to files:
GFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mdGFramework.Core/README.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/abstractions/game-abstractions.mdREADME.mdGFramework.Game.Abstractions/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
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:
GFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mdGFramework.Core/README.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.mdREADME.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to **/README.md : Update the relevant `README.md` or `docs/` page when behavior, setup steps, architecture guidance, or user-facing examples change
Applied to files:
GFramework.Ecs.Arch.Abstractions/README.mddocs/zh-CN/best-practices/index.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mdGFramework.Core/README.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/resource-management.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mdREADME.mdGFramework.Game.Abstractions/README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.cs : Core framework components (Architecture, Module, System, Context, Registry, Service Module, 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/abstractions/index.mdGFramework.Ecs.Arch/README.mdGFramework.Core.Abstractions/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to docs/** : For integration-oriented features such as AI-First config system, documentation MUST cover project directory layout, file conventions, required wiring, minimal working example, and migration notes
Applied to files:
docs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/tutorials/large-project-organization.mdGFramework.Game/README.mdGFramework.Core/README.mddocs/zh-CN/tutorials/data-migration.mdGFramework.Game.Abstractions/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to docs/** : The main documentation site lives under `docs/` with Chinese content under `docs/zh-CN/`; keep code samples, package names, and command examples aligned with current repository state
Applied to files:
docs/zh-CN/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/tutorials/large-project-organization.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.mddocs/.vitepress/config.mtsdocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/functional-programming.mddocs/zh-CN/tutorials/pause-system.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/best-practices/index.mddocs/zh-CN/godot/resource.mddocs/zh-CN/tutorials/godot-complete-project.mddocs/zh-CN/game/setting.mddocs/zh-CN/tutorials/large-project-organization.mddocs/zh-CN/abstractions/index.mddocs/zh-CN/godot/setting.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/unit-testing.mddocs/zh-CN/godot/storage.mddocs/zh-CN/tutorials/data-migration.mddocs/zh-CN/tutorials/save-system.mddocs/zh-CN/tutorials/index.mddocs/zh-CN/abstractions/game-abstractions.mdREADME.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.mddocs/.vitepress/config.mtsdocs/zh-CN/troubleshooting.mddocs/zh-CN/tutorials/pause-system.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Every user-facing package or module directory that contains a `*.csproj` intended for direct consumption MUST have a sibling `README.md` with specific required sections
Applied to files:
docs/zh-CN/best-practices/index.mdGFramework.Core/README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
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:
docs/zh-CN/best-practices/index.mdGFramework.Core/README.mdGFramework.Core.Abstractions/README.mddocs/zh-CN/tutorials/data-migration.mdGFramework.Game.Abstractions/README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.cs : All public, protected, and internal types and members MUST include XML documentation comments (`///`) using `<summary>`, `<param>`, `<returns>`, `<exception>`, and `<remarks>` where applicable
Applied to files:
GFramework.Game/README.mdGFramework.Core/README.mdGFramework.Core.Abstractions/README.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST stay reader-facing and not publish governance-only content such as inventory tables, coverage baselines, review queues, or audit notes
Applied to files:
GFramework.Game/README.mdGFramework.Core/README.mdGFramework.Game.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-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to {README.md,docs/**} : Public documentation MUST present limitations, suitability, and migration boundaries as adoption guidance, not internal-governance or product-roadmap wording
Applied to files:
GFramework.Core/README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.Tests/*.cs : Public API changes must be covered by unit or integration tests
Applied to files:
docs/zh-CN/tutorials/unit-testing.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/tutorials/unit-testing.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.Tests/** : Mirror the source structure in test projects whenever practical
Applied to files:
docs/zh-CN/tutorials/unit-testing.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.Tests/*.cs : Reuse existing architecture test infrastructure when relevant: `ArchitectureTestsBase<T>`, `SyncTestArchitecture`, `AsyncTestArchitecture`
Applied to files:
docs/zh-CN/tutorials/unit-testing.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.Tests/*.cs : Regression fixes should include a test that fails before the fix and passes after it
Applied to files:
docs/zh-CN/tutorials/unit-testing.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.Tests/*.cs : Keep tests focused on observable behavior, not implementation trivia
Applied to files:
docs/zh-CN/tutorials/unit-testing.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to ai-plan/public/README.md : When a worktree-to-topic mapping changes or a topic becomes active/inactive, contributors MUST update `ai-plan/public/README.md` in the same change
Applied to files:
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-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.cs : Generated logic and source generator pipelines MUST explain what is generated, why, semantic assumptions the generator relies on, and diagnostics or fallback behavior
Applied to files:
README.mdGFramework.Game.SourceGenerators/README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.SourceGenerators/*.cs : Keep source generators deterministic and free of hidden environment or network dependencies
Applied to files:
README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.SourceGenerators.Tests/*.cs : Source generator changes MUST be covered by generator tests, preserving snapshot-based verification patterns already used in the repository
Applied to files:
GFramework.Game.SourceGenerators/README.md
📚 Learning: 2026-04-25T03:13:31.755Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.755Z
Learning: Applies to **/*.SourceGenerators.Tests/** : When generator behavior changes intentionally, update snapshots together with the implementation
Applied to files:
GFramework.Game.SourceGenerators/README.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
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-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to ai-plan/public/** : 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-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to ai-plan/public/** : 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-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
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/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to ai-plan/public/*/todos/** : 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/traces/documentation-full-coverage-governance-trace.mdai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
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
Applied to files:
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
📚 Learning: 2026-04-25T03:13:31.756Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Applies to docs/** : 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
Applied to files:
docs/.vitepress/config.mts
🪛 LanguageTool
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
[grammar] ~49-~49: Ensure spelling is correct
Context: ...剩余问题更可能落在非重复性 prose 调整、复杂示例结构或远端 review 反馈，不宜按本轮同一批处理模板继续盲扫。 - PR #287 的 latest-head review 本轮未重新抓取；若继续...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (35)
docs/zh-CN/tutorials/unit-testing.md (1)
949-970: 代码块语言标识符添加正确将项目结构示例和测试输出示例的代码围栏更新为使用
text语言标识符是恰当的改进。这有助于 Markdown 渲染器正确识别和渲染这些非代码内容块（目录树结构和控制台输出）。Also applies to: 1000-1010
docs/zh-CN/tutorials/functional-programming.md (1)
778-801: 输出示例格式化改进将运行结果代码围栏更新为
text类型是正确的做法，确保控制台输出内容能够以纯文本形式正确渲染。docs/zh-CN/tutorials/godot-complete-project.md (1)
74-99: 项目结构示例格式统一为项目结构目录树添加
text语言标识符是良好的文档实践，有助于提高不同 Markdown 渲染器之间的一致性。docs/zh-CN/tutorials/state-machine-tutorial.md (1)
630-642: 文档格式改进符合规范项目结构和运行结果两处代码围栏都正确地添加了
text语言标识符，这与本次 PR 的整体文档格式统一目标一致。Also applies to: 648-723
docs/zh-CN/best-practices/index.md (1)
124-152: 最佳实践文档格式优化项目结构示例使用
text语言标识符是正确的选择，确保目录树结构能够清晰、一致地呈现给读者。docs/zh-CN/troubleshooting.md (1)
25-27: 故障排除文档格式全面改进将所有错误信息代码围栏统一更新为
text语言标识符是非常好的改进：
- 确保错误消息以纯文本形式呈现，避免语法高亮干扰
- 提高故障排除文档的可读性
- 在整个文档中保持一致的格式规范
这种统一的格式化处理使得错误信息更容易识别和复制。
Also applies to: 59-61, 96-98, 129-131, 169-171, 211-213, 257-259, 802-804, 968-970, 1015-1016, 1112-1113, 1638-1640, 1670-1672, 1697-1699, 1772-1774, 1807-1809, 1923-1925, 1963-1965, 2000-2002
docs/zh-CN/tutorials/data-migration.md (1)
556-567: 数据迁移教程格式统一项目结构和运行结果示例正确使用
text语言标识符，与其他教程文档保持一致的格式规范。Also applies to: 573-635
docs/zh-CN/tutorials/large-project-organization.md (1)
32-139: 大型项目文档格式完善项目目录结构示例和运行结果输出正确使用
text语言标识符：
- 复杂的目录树结构使用
text确保清晰呈现- 控制台输出使用
text避免不必要的语法高亮- 与本次 PR 的整体文档格式化目标完美契合
本次文档更新在所有 8 个文件中保持了一致的格式改进，提升了中文文档的整体质量。
Also applies to: 1532-1617
docs/zh-CN/tutorials/pause-system.md (1)
825-825: LGTM - 代码块语言标记标准化将项目结构和运行结果的代码块从未指定语言改为
text类型，这样可以确保 VitePress 正确渲染纯文本内容（目录结构、控制台输出等），提升文档可读性。Also applies to: 914-914
docs/zh-CN/best-practices/architecture-patterns.md (1)
3046-3046: LGTM - 决策树代码块标记优化为模式选择决策树添加
text语言标记，确保 ASCII 图表正确渲染。与本 PR 中其他文档的标准化改进保持一致。docs/zh-CN/tutorials/resource-management.md (1)
692-692: LGTM - 文档代码块标准化为项目结构和运行结果示例添加
text语言标记，与其他教程文档保持一致的格式规范。Also applies to: 712-712
docs/zh-CN/tutorials/index.md (1)
125-125: LGTM - 学习路径代码块标准化为三条学习路径的流程图添加
text语言标记，确保路径箭头和描述在 VitePress 中正确显示。Also applies to: 136-136, 147-147
docs/zh-CN/tutorials/save-system.md (1)
813-813: LGTM - 文档格式标准化与清理
- 为项目结构和控制台输出添加
text语言标记- 修复文件末尾缺少换行符的问题
这些改进符合文档最佳实践。
Also applies to: 832-832, 966-966
GFramework.Game.Abstractions/README.md (1)
134-137: LGTM - XML 文档导航措辞优化将 "XML 覆盖基线" 改为 "XML 阅读入口"，并重写说明文字，使其更加面向读者而非内部治理指标。这一改进：
- 使用 "阅读入口" 比 "覆盖基线" 更友好、更明确地表达文档用途
- 强调帮助读者建立阅读顺序，而非统计覆盖率
- 符合公共文档应保持面向读者的编写准则
与本 PR 在其他 README 中的类似改进保持一致。
GFramework.Core.Abstractions/README.md (1)
37-40: LGTM - XML 文档导航全面优化
- 标题更新："XML 覆盖基线" → "XML 阅读入口"，"重点 XML 关注点" → "推荐优先阅读的 XML 类型族"
- 内容重写：从统计覆盖率转向帮助读者定位和导航
- 用例调整：强调模块拆分、测试替身、接口适配等实际场景
这些改进使文档更加实用和易读，与
GFramework.Game.Abstractions/README.md的改进保持一致。Also applies to: 60-62
GFramework.Game.SourceGenerators/README.md (1)
47-49: LGTM - XML 文档导航措辞统一与
GFramework.Core.Abstractions和GFramework.Game.Abstractions保持一致，将 XML 文档部分的措辞从 "覆盖基线" 改为 "阅读入口"，并重写说明：
- 强调类型级文档入口的定位作用
- 将成员级细节的核对从 "需要" 改为 "建议"，语气更友好
- 完成了本 PR 在所有模块 README 中的术语标准化
docs/zh-CN/ecs/arch.md (1)
21-21: 链接标签改为语义化名称，方向正确。本次把路径式文案替换为“ECS 抽象层说明”，可读性和导航体验更好，且不改变跳转目标。
docs/zh-CN/godot/setting.md (1)
140-140: 跨页引用文案统一为业务语义标题，赞同。“Game 设置系统 / Game 存储系统”比原路径形式更清晰，符合公开文档的阅读导向。
Also applies to: 146-146
docs/zh-CN/contributing.md (1)
321-321: 代码块语言标注改为text合理。该改动提升了文档渲染一致性，且不改变提交规范内容。
docs/zh-CN/abstractions/index.md (1)
18-20: 抽象层导航链接命名更清晰，建议保留。“X 抽象层说明”这类标签可直接传达页面用途，降低读者理解成本。
docs/zh-CN/game/serialization.md (1)
149-149: 引用链接改为“配置系统”命名，表达更准确。这是面向读者的正向优化，保留原目标路径也避免了行为变化。
docs/zh-CN/godot/resource.md (1)
545-545: 目录树示例使用textfence 是正确的规范化调整。可读性更稳定，也更符合文档渲染预期。
docs/zh-CN/game/setting.md (1)
198-198: 迁移边界的参考文案更精确，改得好。“数据与存档系统”比泛化指向更利于读者快速定位迁移语义。
GFramework.Ecs.Arch.Abstractions/README.md (1)
36-36: “XML 阅读入口”的命名更贴近使用场景。标题与说明语气更中性、更面向读者，和 README 的定位一致。
Also applies to: 38-38
README.md (1)
42-43: 链接文案统一为「模块说明」，与其他行保持一致。变更仅修改显示文本，目标 URL 未变；与上文「模块地图」表中的命名风格一致，读者面更友好。
docs/zh-CN/abstractions/game-abstractions.md (1)
112-115: 阅读顺序链接文案标准化，符合公开文档可读性要求。将原本基于路径的链接文本替换为语义化标题（"Game 模块总览"、"配置系统"、"数据系统"），目标地址未变，与本 PR 其他文档保持一致。
As per coding guidelines: "Public documentation MUST use semantic section titles and link labels without exposing raw filenames or paths".
docs/zh-CN/game/storage.md (1)
164-165: 链接文案语义化，与全 PR 风格一致。"数据与存档系统"、"设置系统" 替换原始路径式文本，目标 URL 未变。
docs/zh-CN/godot/storage.md (1)
111-122: Godot 存储页跨模块跳转文案改为可读标题。"Game 配置系统" / "Game 存储系统" 取代原路径式文本，与同 PR 其他页面保持一致；这些目标页（
../game/config-system.md、../game/storage.md）确实存在于本仓库docs/zh-CN/game/下，链接有效。docs/.vitepress/config.mts (1)
255-262: 所有侧栏条目的落地页均已存在。经验证，四个新增的生成器侧栏条目已有对应的 markdown 文件：
docs/zh-CN/source-generators/auto-register-module-generator.md✓docs/zh-CN/source-generators/auto-ui-page-generator.md✓docs/zh-CN/source-generators/auto-scene-generator.md✓docs/zh-CN/source-generators/auto-register-exported-collections-generator.md✓无需修改。
> Likely an incorrect or invalid review comment.ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md (1)
5-54: 恢复点推进文档完整且合规本次从 RP-034 到 RP-035 的跟踪记录完整覆盖了所有必需元素：
- ✅ 清晰记录了 baseline 重置、worker 批次接受与文件计数投影
- ✅ 明确了自动化规则的边界决策（仅处理 opening fence，排除嵌套结构）
- ✅ 提供了全面的验证里程碑（README 链接、教程、最佳实践、排障、站点构建）
- ✅ 给出了具体的下一步建议（复核 PR
#287review 状态）符合编码指南要求：跟踪文档必须记录当前日期、关键决策、验证里程碑和下一步。
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md (5)
15-22: 恢复点更新与跟踪文档同步良好当前恢复点部分正确更新到 RP-035，与对应的 trace 文件保持一致：
- 恢复点标识符、baseline 提交、worker 批次、文件计数投影均同步
- 当前焦点清晰描述了批次范围与停止原因
- 符合编码指南要求：跟踪文档必须记录当前阶段、恢复点标识符、已知风险和下一步建议
27-33: 当前状态摘要全面反映已完成工作状态更新详细记录了：
- 已提交批次（094e29e）与未提交工作树的覆盖范围
- 具体的文档改进内容（导航补齐、语义化链接、代码块标记）
- reader-facing 改写的范围与保留的证据链
符合编码指南要求：跟踪更新必须反映已完成工作、新发现的问题、验证结果和下一个推荐的恢复点。
48-50: 风险评估准确识别自动化边界当前风险部分正确识别了：
contributing.md:631嵌套 fenced 示例不适合自动处理- 低风险可重复切片已耗尽，避免盲目扩批
- PR
#287review 状态需重新确认这些风险评估为下一步决策提供了清晰的约束条件。
67-80: 验证结果完整且与 trace 一致最新验证部分补充了全面的验证命令与结果：
- README 链接校验、教程/最佳实践/排障页校验
- 明确标注了
contributing.md:631的既有警告状态- 站点构建验证确认无回归
与 trace 文件中的验证里程碑保持同步。
131-137: 下一步建议合理且可操作下一步部分提供了清晰的恢复指导：
- 建议在 34/50 停止当前批次
- 优先复核 PR
#287review 状态再继续- 对
contributing.md:631建议人工评估而非自动处理这些建议与 trace 文件一致，符合编码指南要求的"下一个推荐恢复步骤"。
- 更新 source-generators 侧栏标签并移除 API 参考侧栏中的跨栏目重复入口 - 优化 Core、Ecs.Arch、Game README 的 XML 阅读入口表述，删除覆盖基线式字段 - 补充 documentation-full-coverage-governance 跟踪与验证记录，记录 PR #290 审查收口状态
Summary
Test Results
Details
Insights
build-and-test: Run #972
🎉 All tests passed!Slowest Tests
± Comparison with run #971 at 4022878 | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 29 runs. Github Test Reporter by CTRF 💚 |
1 participant
Summary by CodeRabbit
发行说明