Skip to content

docs: clarify meta-package scope, source generator contracts, and add Game config tool documentation#292

Merged
GeWuYou merged 4 commits into
mainfrom
docs/sdk-update-documentation
Apr 26, 2026
Merged

docs: clarify meta-package scope, source generator contracts, and add Game config tool documentation#292
GeWuYou merged 4 commits into
mainfrom
docs/sdk-update-documentation

Conversation

@GeWuYou
Copy link
Copy Markdown
Owner

@GeWuYou GeWuYou commented Apr 25, 2026

Summary by CodeRabbit

发布说明

  • 新功能

    • Game 配置工具:新增 VS Code 扩展使用文档,支持 YAML/JSON Schema 工作流
  • 文档

    • 新增并细化多个源生成器合约与共享模块的 README(含中文说明)
    • 更新安装/首页与导航,明确元包包含范围与运行时要求(.NET 8+/Godot 4.6.2)
    • 丰富 CQRS、枚举/节点生成器与注入约束等使用说明
    • 修复文档渲染与侧边栏导航项更新
  • Chore

    • 更新元包描述与文档治理跟踪记录

GeWuYou added 2 commits April 25, 2026 16:33
- 修复 contributing 文档中的 Mermaid 示例围栏写法,消除剩余代码块语言警告
- 更新 documentation-full-coverage-governance 的 tracking 与 trace,记录 RP-037、基线和验证结果
- 更新 meta-package 与安装入口,明确聚合范围、当前运行时基线和首页选包路径
- 补充 Game 配置工具文档与导航,把 VS Code config workflow 纳入 reader-facing 采用链路
- 修正文档与实现不一致的 source-generator 与 CQRS 契约说明,补充 support module 边界
- 记录 RP-038 批处理恢复点、委派结论和本轮验证结果
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

Warning

Rate limit exceeded

@GeWuYou has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 23 minutes and 52 seconds before requesting another review.

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 23 minutes and 52 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 840b7225-fdcd-4d1b-acbd-5e36b2c7041b

📥 Commits

Reviewing files that changed from the base of the PR and between d3d62cf and 65d3634.

📒 Files selected for processing (3)
  • ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
  • ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
  • tools/gframework-config-tool/README.md
📝 Walkthrough

Walkthrough

本 PR 主要补充与澄清了源生成器抽象层与共享支持模块的 README,新增并扩展了 Game 配置工具文档,调整若干源生成器、CQRS 与安装/首页文档中的语义说明与示例,同时更新元包描述与文档治理跟踪记录。

Changes

Cohort / File(s) Summary
源生成器抽象层 README
GFramework.Core.SourceGenerators.Abstractions/README.md, GFramework.Godot.SourceGenerators.Abstractions/README.md, GFramework.SourceGenerators.Common/README.md
新增三个 README,说明 Core/Godot 的属性合约与共享支持模块的职责、不可单独打包(IsPackable=false)及与生成器主逻辑的边界。
源生成器文档澄清
docs/zh-CN/source-generators/index.md, docs/zh-CN/source-generators/context-get-generator.md, docs/zh-CN/source-generators/enum-generator.md, docs/zh-CN/source-generators/get-node-generator.md, docs/zh-CN/api-reference/index.md
补充 Common 与 Abstractions 目录的定位说明;放宽集合注入类型约束;移除未实现的 enum 配置项示例;澄清 GetNodeAttribute 在 Path 显式设置时的优先级与生成语义。
Game 模块配置工具
docs/zh-CN/game/config-tool.md, docs/zh-CN/game/index.md, docs/zh-CN/game/config-system.md, tools/gframework-config-tool/README.md, docs/.vitepress/config.mts
新增 VS Code 配置工具中文文档、更新工具 README、在 Game 文档与侧边栏增加入口与交叉引用,说明工作区约定、功能范围与使用建议。
CQRS 与首页更新
docs/zh-CN/core/cqrs.md, docs/zh-CN/index.md
为 CQRS 增加协程桥接与普通/流式 Request 合约说明;更新首页文档以突出包选择路径、配置工具与生成器协作能力。
包元数据与安装指南
GFramework.csproj, docs/zh-CN/getting-started/installation.md, README.md
更新 GFramework 元包的 <Description> 为仅聚合 Core 与 Game;说明需单独安装 Cqrs/Godot/SourceGenerators;将示例目标框架改为 net8.0,更新最低兼容运行时/引擎版本。
文档治理跟踪
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md, ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
推进恢复点与跟踪记录(RP-036 → RP-039 等),更新治理批次阈值、已验收的文档片段与下一步计划。
其他文档修正
docs/zh-CN/contributing.md, docs/zh-CN/core/cqrs.md, docs/zh-CN/source-generators/context-get-generator.md, docs/zh-CN/source-generators/enum-generator.md, docs/zh-CN/source-generators/get-node-generator.md, docs/zh-CN/index.md
修正 Mermaid fenced-block、调整文档标题/结构与若干示例与术语表述。

估算代码审查工作量

🎯 3 (Moderate) | ⏱️ ~20 minutes

可能相关的 PR

概览

本 PR 更新了多个 README 文档以阐明源生成器抽象层、共享支持模块的角色定义,并扩充了 Game 模块的配置工具文档。同时对 CQRS、源生成器属性约束进行了文档澄清,更新了版本要求和包元数据,推进了文档完整性治理。

更改内容

内聚组 / 文件 概述
源生成器抽象层 README
GFramework.Core.SourceGenerators.Abstractions/README.md, GFramework.Godot.SourceGenerators.Abstractions/README.md, GFramework.SourceGenerators.Common/README.md
新增三个 README 文档,分别说明 Core/Godot 源生成器抽象层和共享支持模块的角色:这些目录作为合约层/共享基础设施,不可独立作为 NuGet 包安装。
源生成器文档澄清
docs/zh-CN/source-generators/index.md, docs/zh-CN/source-generators/context-get-generator.md, docs/zh-CN/source-generators/enum-generator.md, docs/zh-CN/source-generators/get-node-generator.md, docs/zh-CN/api-reference/index.md
更新源生成器相关文档:补充共享支持模块说明;调整集合注入类型约束(允许继承自 IReadOnlyList<T> 的类型);移除未实现的配置选项;澄清 GetNodeAttribute.LookupPath 的优先级关系。
Game 模块配置工具文档
docs/zh-CN/game/config-tool.md, docs/zh-CN/game/index.md, docs/zh-CN/game/config-system.md, tools/gframework-config-tool/README.md, docs/.vitepress/config.mts
新增 VS Code 配置工具完整文档,含工作区约定、功能范围、操作建议和设置说明;更新 Game 导航菜单和相关交叉引用;重构工具 README 以突出编辑器伴侣定位。
CQRS 与首页文档更新
docs/zh-CN/core/cqrs.md, docs/zh-CN/index.md
补充 CQRS 协程桥接指导和普通/流式 Request 合约说明;更新首页功能描述和行动链接,指向包选择路径和配置工具。
包元数据与安装指南
GFramework.csproj, docs/zh-CN/getting-started/installation.md, README.md
更新 GFramework 元包描述为仅聚合 Core/Game;澄清 Cqrs/Godot/SourceGenerators 需单独安装;升级环境要求为 .NET 8.0+ 和 Godot 4.6.2。
文档治理跟踪
ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md, ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
推进恢复点从 RP-036 至 RP-038;记录源生成器支持文档、CQRS 覆盖、元包澄清完成状态及后续扩展约束。

预期代码审查工作量

🎯 2 (Simple) | ⏱️ ~12 minutes

可能相关的 PR

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 标题清晰准确地总结了 PR 的主要变更:澄清元包范围、源生成器契约关系,以及添加游戏配置工具文档。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sdk-update-documentation

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
2156 2156 0 0 0 0 35.7s    ↓729ms

Test Results

passed 2156 passed

Details

tests 2156 tests
clock 35.7s ↓729ms
tool nunit
build CI - Build & Test arrow-right build-and-test link #976
pull-request Docs/sdk update documentation link #292

Insights

Average Tests per Run Total Flaky Tests Total Failed Slowest Test (p95)
2144 0 0 5.4s

build-and-test: Run #976

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Pending ⏳ Other ❓ Flaky 🍂 Duration ⏱️
2156 2156 0 0 0 0 0 35.7s

🎉 All tests passed!

Slowest Tests

Test 📝 Results 📊 Duration (avg) ⏱️ Duration (p95) ⏱️
Does_Not_Report_When_FieldInjectedModel_Is_Registered 30 2.4s 5.4s
SendRequestAsync_Should_ResolveCqrsRuntime_OnlyOnce_When_AccessedConcurrently 30 4.3s 4.8s
Generates_Scene_Behavior_Boilerplate 30 2.0s 4.6s
Context_Caching_Should_Improve_Performance 30 803ms 1.1s
CleanupDuringAcquire_Should_NotCauseRaceCondition 30 1.1s 1.1s
Append_ShouldNotBlock 30 1.0s 1.0s
RegisterCqrsHandlersFromAssembly_Should_Deduplicate_Repeated_Assembly_Registration 30 231ms 791ms
ConfigModuleCanRunDuringArchitectureInitialization 30 217ms 550ms
PendingCount_ShouldReflectQueuedEntries 30 501ms 501ms
Cleanup_Should_NotRemoveActiveLocks 30 404ms 406ms

± Comparison with run #972 at 6d47528 | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 30 runs.

Github Test Reporter by CTRF 💚

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 25, 2026

Greptile Summary

This PR is a documentation-only update (plus a one-line meta-package description fix) covering four areas: clarifying that GeWuYou.GFramework is a Core + Game-only meta-package, adding a new VS Code config tool page and wiring it into the Game sidebar and navigation, correcting source-generator contract documentation (collection injection constraints, explicit Path/Lookup precedence, and removing an "unimplemented" section for options that no longer exist in the attribute class), and adding README files for the three internal support directories. Runtime requirements are also updated from .NET 6.0 to .NET 8.0/9.0/10.0 and Godot from 4.5+ to 4.6.2.

Confidence Score: 5/5

Safe to merge — all changes are documentation and a trivial metadata string; no runtime behavior is affected.

All 21 changed files are documentation or metadata. Code-facing changes are limited to correcting stale documentation against verified source (enum attribute no longer has GenerateHasMethod/IncludeToString; collection constraints now match the actual generator). The site build, link validation, and tool tests were confirmed passing per the governance trace. No P0 or P1 findings.

No files require special attention.

Important Files Changed

Filename Overview
GFramework.csproj Replaces placeholder "404 not found" description with an accurate meta-package summary clarifying scope.
tools/gframework-config-tool/README.md Major restructuring: adds Purpose, Recommended Workspace Layout, What It Adds, Quick Start, Documentation links, and moves Current Constraints before Local Testing for better readability.
docs/zh-CN/game/config-tool.md New page documenting the VS Code config tool: covers usage scope, workspace layout, commands, workflows, settings, and current constraints.
docs/zh-CN/getting-started/installation.md Updates runtime requirements from .NET 6.0 to .NET 8.0/9.0/10.0 and Godot from 4.5+ to 4.6.2; adds meta-package scope clarification.
docs/zh-CN/source-generators/enum-generator.md Removes "unimplemented options" section for GenerateHasMethod and IncludeToString, which no longer exist in the attribute class. Correct cleanup.
docs/zh-CN/source-generators/get-node-generator.md Clarifies that an explicit Path is used verbatim and Lookup does not rewrite it; adds a lookup behavior table and code example.
docs/zh-CN/source-generators/context-get-generator.md Corrects collection injection type constraints from strict IReadOnlyList to "assignable from IReadOnlyList", matching actual generator behavior.
docs/zh-CN/core/cqrs.md Adds Request/stream variant coverage (RequestBase, IStreamCommand, IStreamQuery, handlers) and coroutine bridge entry, with updated reference table.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User lands on docs homepage] --> B{What do they need?}
    B --> C[Install packages\ninstallation.md]
    B --> D[Use CQRS\ncqrs.md]
    B --> E[Game config workflow]
    E --> F[config-system.md]
    E --> G[config-tool.md NEW]
    G --> H[VS Code Extension\ntools/gframework-config-tool]
    B --> I[Source Generators\nindex.md]
    I --> J[Core Abstractions README NEW]
    I --> K[Godot Abstractions README NEW]
    I --> L[SourceGenerators.Common README NEW]
    I --> M[context-get-generator.md\ncollection constraint fix]
    I --> N[enum-generator.md\nremoved stale unimplemented section]
    I --> O[get-node-generator.md\nPath/Lookup clarification]
Loading

Reviews (3): Last reviewed commit: "docs(config-tool): 补充配置工具最小接入路径" | Re-trigger Greptile

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 25, 2026

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ REPOSITORY gitleaks yes no no 3.84s
✅ REPOSITORY trufflehog yes no no 4.07s

See detailed reports in MegaLinter artifacts
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@GeWuYou
Copy link
Copy Markdown
Owner Author

GeWuYou commented Apr 25, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 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/source-generators/index.md`:
- Around line 34-39:
将句子“对读者更重要的判断是:”替换为更通顺的表达“对读者更重要的是先判断:”,更新位于文档中包含原句的那一段(查找文本片段“对读者更重要的判断是”或整句上下文),确保后续列点保持不变并且标点(冒号)延续原格式以保持可读性和一致性。

In `@tools/gframework-config-tool/README.md`:
- Around line 5-15: 在 tools/gframework-config-tool/README.md
中补充缺失的中文文档入口与必要说明:在当前模块说明段(README)末尾添加指向 docs/zh-CN/ 的显式链接与路径提示(例如
docs/zh-CN/tools/gframework-config-tool 或通用 docs/zh-CN 索引),并补充模块与相邻包的关系、主要子目录(如
config/, schemas/, src/ 或 generator 输出目录)、最低采用路径(最小配置步骤说明)以及“对应 docs/zh-CN/
入口已在此处”的简短说明;确保引用文件名 README.md 和目标目录 docs/zh-CN/ 来便于定位。
🪄 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: 0fd2cb87-3d18-45a5-8643-b823803f1783

📥 Commits

Reviewing files that changed from the base of the PR and between 79934f7 and b96565f.

📒 Files selected for processing (21)
  • GFramework.Core.SourceGenerators.Abstractions/README.md
  • GFramework.Godot.SourceGenerators.Abstractions/README.md
  • GFramework.SourceGenerators.Common/README.md
  • GFramework.csproj
  • README.md
  • ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
  • ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
  • docs/.vitepress/config.mts
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/contributing.md
  • docs/zh-CN/core/cqrs.md
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/game/config-tool.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/getting-started/installation.md
  • docs/zh-CN/index.md
  • docs/zh-CN/source-generators/context-get-generator.md
  • docs/zh-CN/source-generators/enum-generator.md
  • docs/zh-CN/source-generators/get-node-generator.md
  • docs/zh-CN/source-generators/index.md
  • tools/gframework-config-tool/README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (11)
**/*.csproj

📄 CodeRabbit inference engine (AGENTS.md)

**/*.csproj: Follow repository defaults: ImplicitUsings disabled, Nullable enabled, GenerateDocumentationFile enabled for shipped libraries, LangVersion generally preview in main libraries
Minimize new package dependencies and add them only when necessary with narrow scope

Files:

  • GFramework.csproj
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.md
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/get-node-generator.md
  • docs/zh-CN/source-generators/enum-generator.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • docs/zh-CN/getting-started/installation.md
  • docs/zh-CN/core/cqrs.md
  • docs/zh-CN/index.md
  • docs/zh-CN/source-generators/context-get-generator.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.md
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/get-node-generator.md
  • docs/zh-CN/source-generators/enum-generator.md
  • README.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • docs/zh-CN/getting-started/installation.md
  • docs/zh-CN/core/cqrs.md
  • docs/zh-CN/index.md
  • docs/zh-CN/source-generators/context-get-generator.md
docs/**

📄 CodeRabbit inference engine (AGENTS.md)

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
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.md
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/get-node-generator.md
  • docs/zh-CN/source-generators/enum-generator.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • docs/zh-CN/getting-started/installation.md
  • docs/zh-CN/core/cqrs.md
  • docs/zh-CN/index.md
  • docs/zh-CN/source-generators/context-get-generator.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.md
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/get-node-generator.md
  • docs/zh-CN/source-generators/enum-generator.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • docs/zh-CN/getting-started/installation.md
  • docs/zh-CN/core/cqrs.md
  • docs/zh-CN/index.md
  • docs/zh-CN/source-generators/context-get-generator.md
**/README.md

📄 CodeRabbit inference engine (AGENTS.md)

**/README.md: Use the canonical filename README.md (not ReadMe.md or 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's README.md in the same change
Update the relevant README.md or docs/ page when behavior, setup steps, architecture guidance, or user-facing examples change

Files:

  • GFramework.Core.SourceGenerators.Abstractions/README.md
  • README.md
  • tools/gframework-config-tool/README.md
  • GFramework.SourceGenerators.Common/README.md
  • GFramework.Godot.SourceGenerators.Abstractions/README.md
README.md

📄 CodeRabbit inference engine (AGENTS.md)

README.md: The repository root README.md MUST mirror the current top-level documentation taxonomy used by the docs site
Prefer linking the root README.md to section landing pages such as index.md instead 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 committed ai-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.md
  • ai-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.md
  • ai-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 under ai-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 under ai-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 (37)
📓 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-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:

  • GFramework.csproj
📚 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 **/*.csproj : Minimize new package dependencies and add them only when necessary with narrow scope

Applied to files:

  • GFramework.csproj
📚 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:

  • GFramework.csproj
  • docs/zh-CN/source-generators/index.md
  • GFramework.SourceGenerators.Common/README.md
  • docs/zh-CN/getting-started/installation.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:

  • GFramework.csproj
  • GFramework.Core.SourceGenerators.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: The commit `summary` MUST use simplified Chinese and briefly describe the main change

Applied to files:

  • docs/zh-CN/contributing.md
  • docs/.vitepress/config.mts
  • docs/zh-CN/game/config-system.md
  • README.md
  • docs/zh-CN/game/config-tool.md
  • GFramework.SourceGenerators.Common/README.md
  • ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
  • docs/zh-CN/index.md
  • 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: The commit `body` MUST use unordered list items with each item starting with a verb such as 新增、修复、优化、更新、补充、重构

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/.vitepress/config.mts
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/enum-generator.md
  • README.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • GFramework.SourceGenerators.Common/README.md
  • docs/zh-CN/getting-started/installation.md
  • ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md
  • docs/zh-CN/core/cqrs.md
  • docs/zh-CN/index.md
  • 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
📚 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/.vitepress/config.mts
  • docs/zh-CN/game/config-system.md
  • docs/zh-CN/api-reference/index.md
  • README.md
  • docs/zh-CN/game/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • GFramework.SourceGenerators.Common/README.md
  • docs/zh-CN/getting-started/installation.md
  • docs/zh-CN/index.md
  • 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/** : 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/game/config-system.md
  • GFramework.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • README.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/game/config-tool.md
  • tools/gframework-config-tool/README.md
  • GFramework.SourceGenerators.Common/README.md
  • docs/zh-CN/getting-started/installation.md
  • GFramework.Godot.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/index.md
  • 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/** : 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/game/config-system.md
  • GFramework.SourceGenerators.Common/README.md
  • docs/zh-CN/index.md
  • 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 **/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.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • README.md
  • docs/zh-CN/source-generators/index.md
  • tools/gframework-config-tool/README.md
  • GFramework.SourceGenerators.Common/README.md
  • GFramework.Godot.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/index.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:

  • GFramework.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • README.md
  • GFramework.SourceGenerators.Common/README.md
  • GFramework.Godot.SourceGenerators.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 : 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:

  • GFramework.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/index.md
  • GFramework.SourceGenerators.Common/README.md
  • GFramework.Godot.SourceGenerators.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 **/*.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.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/index.md
  • GFramework.SourceGenerators.Common/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.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/core/cqrs.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:

  • GFramework.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/index.md
  • GFramework.SourceGenerators.Common/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.Core.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/api-reference/index.md
  • README.md
  • docs/zh-CN/game/index.md
  • tools/gframework-config-tool/README.md
  • GFramework.SourceGenerators.Common/README.md
  • GFramework.Godot.SourceGenerators.Abstractions/README.md
  • docs/zh-CN/index.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:

  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/index.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:

  • docs/zh-CN/api-reference/index.md
  • docs/zh-CN/source-generators/index.md
  • docs/zh-CN/index.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:

  • docs/zh-CN/api-reference/index.md
  • tools/gframework-config-tool/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 **/*.cs : Apply [GenerateEnumExtensions] attribute to generate enumeration extension capabilities

Applied to files:

  • docs/zh-CN/source-generators/enum-generator.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:

  • README.md
  • tools/gframework-config-tool/README.md
  • docs/zh-CN/index.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.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 : Use namespace pattern `GFramework.{Module}.{Feature}` with PascalCase segments

Applied to files:

  • docs/zh-CN/getting-started/installation.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.md
  • 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 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/** : 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.md
  • 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 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.md
  • 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 ai-plan/public/** : 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

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/*/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/traces/documentation-full-coverage-governance-trace.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:

  • docs/zh-CN/core/cqrs.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 **/*{Startup,Init,Register,Setup,Configure}*.cs : CQRS handler registration should use generated products from CqrsHandlerRegistryGenerator at runtime, falling back to reflection scanning when generation cannot cover cases; explicitly register handlers from non-default assemblies using RegisterCqrsHandlersFromAssembly(...) or RegisterCqrsHandlersFromAssemblies(...)

Applied to files:

  • docs/zh-CN/core/cqrs.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:

  • 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 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-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: Contributors MUST NOT treat a repeated incremental `dotnet build` result as authoritative for warning inspection when a clean baseline has not been captured

Applied to files:

  • ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md
🪛 LanguageTool
docs/zh-CN/api-reference/index.md

[uncategorized] ~81-~81: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:新"地"安装
Context: ... 或冲突语义,优先把它理解为共享 支撑层在复用同一套规则,而不是把这些目录当成新的安装入口。 ## 使用方式 把本页当成“API 阅读导航”而不是“签名快照”...

(wb4)

docs/zh-CN/source-generators/index.md

[uncategorized] ~34-~34: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:新"地"安装
Context: ...[AutoScene][AutoUiPage]。 这些目录当前不是新的安装入口。对读者更重要的判断是: - 应该安装哪个 `*.SourceGene...

(wb4)


[uncategorized] ~34-~34: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:重要"地"判断
Context: ...[AutoUiPage]。 这些目录当前不是新的安装入口。对读者更重要的判断是: - 应该安装哪个 *.SourceGenerators` 包 - ...

(wb4)

docs/zh-CN/game/config-tool.md

[uncategorized] ~126-~126: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:深"地"嵌套
Context: ...- 校验聚焦仓库当前支持的 schema 子集 - 表单预览支持对象数组,但更深的嵌套对象数组仍可能需要回退到 raw YAML - 批量编辑当前聚焦顶层标量和顶...

(wb4)

🔇 Additional comments (25)
docs/zh-CN/contributing.md (1)

625-633: Mermaid 代码块嵌套语法修正正确。

将 Mermaid 示例的嵌套代码栅栏语法从不正确的形式修正为标准的 Markdown 嵌套结构(使用四个反引号包裹三个反引号的 mermaid 代码块),可以正确渲染并消除代码块语言警告。

GFramework.csproj (1)

7-7: 元包描述更新准确。

新的描述清晰说明了 GeWuYou.GFramework 是聚合 GFramework.CoreGFramework.Game 的元包,为最小运行时采用路径提供入口。这与 docs/zh-CN/getting-started/installation.md 中的说明保持一致,准确传达了元包的范围边界。

docs/.vitepress/config.mts (1)

214-214: 侧边栏导航项添加正确。

新增的 "VS Code 配置工具" 导航项与本次 PR 中新增的实际文档页面 docs/zh-CN/game/config-tool.md 相匹配,符合"导航中的文档类别必须有对应的实际落地页"的编码规范。

基于编码规范:如果文档类别出现在 VitePress 导航或侧边栏中,必须在同一变更中拥有真实的落地页或从导航中移除。

docs/zh-CN/game/index.md (2)

34-34: 配置工具入口添加恰当。

将 "VS Code 配置工具" 添加到 Game 模块的配置与内容系统入口列表中,与本次 PR 新增的文档页面相对应,保持了模块入口的完整性。


103-106: 阅读顺序更新正确。

在阅读顺序中插入 "VS Code 配置工具" 作为第 3 步,并正确地重新编号后续步骤,保持了推荐学习路径的连贯性。

docs/zh-CN/game/config-system.md (2)

24-25: 文档交叉引用添加恰当。

在能力说明后添加指向 VS Code 配置工具页面的链接,改善了相关文档之间的导航体验。


983-984: 工具章节交叉引用合理。

在 "VS Code 工具" 章节开头提供完整采用说明的链接,避免在当前页面重复详细内容,保持了文档的简洁性和可维护性。

docs/zh-CN/game/config-tool.md (1)

1-139: 新增 VS Code 配置工具文档页完整且结构清晰。

文档覆盖了工具的定位、适用场景、工作区约定、功能特性、推荐工作流、配置项和使用边界,符合集成导向特性文档的要求。特别值得肯定的是:

  • 明确区分了适用与不适用场景(lines 14-26)
  • 提供了清晰的目录结构示例(lines 29-42)
  • 给出了推荐的分层处理工作流(lines 89-103)
  • 诚实说明了当前边界,并建议在复杂场景下回退到 raw YAML(lines 120-133)

文档与同次 PR 中的其他页面保持了良好的交叉引用一致性。

基于编码规范:对于集成导向的功能(如 AI-First 配置系统),文档必须覆盖项目目录布局、文件约定、必要的接线、最小工作示例和迁移说明。

docs/zh-CN/api-reference/index.md (1)

73-81: 源码生成器支撑模块说明清晰准确。

新增的说明准确区分了:

  • *.SourceGenerators.Abstractions 作为公开 attribute 和最小契约的共享层
  • GFramework.SourceGenerators.Common 作为提供共享基类、diagnostics 和跨模块约束的支撑层

明确指出这些目录不是独立的安装入口,而是支持对应生成器运行的共享模块,有助于防止用户产生安装混淆。这与本次 PR 在多个文档中澄清元包和生成器边界的整体目标保持一致。

docs/zh-CN/getting-started/installation.md (3)

29-34: 元包聚合范围说明准确。

明确说明 GeWuYou.GFramework 元包只聚合 GFramework.CoreGFramework.Game,不包含 CqrsGodot 或任何 *.SourceGenerators 包。这与本次 PR 中 GFramework.csproj 的 Description 更新保持一致,为用户提供了清晰的包选择指导。

基于编码规范:文档中的代码示例、包名和命令示例应与当前仓库状态保持一致。


76-76: 目标框架版本更新合理。

将示例项目的目标框架从 net6.0 更新为 net8.0,与仓库当前支持的 .NET 8.0/9.0/10.0 多目标框架基线保持一致。


120-121: 环境要求版本更新准确。

将运行时和开发工具要求从 .NET 6.0/Godot 4.5+ 更新为 .NET 8.0/9.0/10.0 和 Godot 4.6.2,反映了仓库当前的实际基线要求。版本信息的更新确保了文档与实际项目配置的一致性。

Also applies to: 126-127

docs/zh-CN/core/cqrs.md (4)

96-98: LGTM!协程桥接说明清晰。

新增的协程扩展入口说明简洁明了,为在协程驱动调用链中使用 CQRS 的读者提供了有价值的指引。


112-135: LGTM!Request 与流式变体文档补充完整。

这一节补齐了之前文档中缺失的 Request 与流式变体的说明:

  • 普通 Request 路径提供了中性语义的选择
  • 流式 Command/Query 明确了 IAsyncEnumerable<T> 返回路径
  • 与相关代码片段中的类型定义一致(RequestBaseAbstractStreamRequestHandler 等)

文档语言保持 reader-facing,避免了治理性措辞。


213-217: LGTM!继续阅读链接使用语义化标签。

"继续阅读"部分的链接标签已从文件名改为语义化描述(如"架构与上下文"、"Context 上下文"、"协程系统"),符合 reader-facing 文档的最佳实践。基于 coding guidelines,公开文档必须使用语义化标签,避免暴露原始文件名或路径。


206-207: 表格中的 CQRS 类型已确认存在。

已验证 RequestBaseAbstractRequestHandlerAbstractStreamCommandHandlerAbstractStreamQueryHandler 等新增类型均存在于代码库对应位置。表格描述与源码一致,无需修改。

docs/zh-CN/index.md (2)

18-25: LGTM!Hero actions 提供清晰的导航入口。

Hero actions 从通用的"快速开始/安装"扩展到包含 CQRS 和配置工具的具体入口,为读者提供了更直接的导航路径,符合本 PR 的文档覆盖目标。


29-45: LGTM!Feature highlights 保持 reader-facing 语气。

特性亮点部分的文案技术性强且简洁:

  • 避免了过度营销或 AI 生成式的措辞
  • 使用具体技术术语(CQRS、YAML、JSON Schema、Roslyn 等)
  • 为读者明确了各模块的价值定位

符合 coding guidelines 关于公开文档应保持中立标签、避免 AI 式标题的要求。

ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md (2)

5-47: LGTM!RP-038 恢复点记录完整。

RP-038 恢复点正确记录了:

  • 当前日期与恢复点标识
  • 批处理策略从单点 review 收口到项目级文档补齐的转变
  • 委派的 subagent 探索结论
  • 决策约束(不扩新栏目、stop condition 追踪)
  • 详细的验证命令与通过结果

符合 coding guidelines 关于 trace 文件必须记录日期、关键决策、验证里程碑和下一步的要求。


48-72: LGTM!RP-037 恢复点记录清晰。

RP-037 恢复点准确捕获了:

  • Mermaid 代码块格式修正的具体细节(从嵌套 triple-backtick 改为转义围栏文本)
  • 聚焦的验证范围(消除 contributing.md 的最后一个代码块警告)
  • 单文件与全量文档校验结果
  • 站点构建验证通过

记录方式符合 trace 文件的里程碑追踪要求。

ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md (4)

15-21: LGTM!恢复点推进记录准确。

恢复点从 RP-036 推进到 RP-038,正确记录了:

  • 新的 baseline commit(79934f7)和时间戳
  • 批处理策略从单点收口扩展到项目级功能覆盖
  • Branch diff stop condition(~50 文件阈值)
  • 当前工作树文件统计(18 个文件,14 更新 + 4 新增)

符合 coding guidelines 关于 tracking 文件必须记录当前阶段、恢复点标识和已完成工作的要求。


29-34: LGTM!状态摘要反映文档补充工作。

状态摘要新增的条目准确描述了本批次的文档工作:

  • Line 29-30: Mermaid 代码块修正与全量验证通过
  • Line 31: Meta-package 安装面文档补齐
  • Line 32: Config tool 工具页新增与导航集成
  • Line 33-34: Source generators 契约修正与 support README 补齐

与 AI summary 和 trace 文件中的工作内容一致。


67-100: LGTM!验证日志详实且结构化。

新增的验证条目(2026-04-25 批次)包含:

  • 具体的验证命令(bash 脚本、bun build、dotnet build)
  • 清晰的结果描述(通过/失败、具体输出)
  • 验证覆盖范围(source-generators、game、core/cqrs.md、index.md、README 链接等)

验证日志的完整性符合 tracking 文件必须反映验证结果和下一个推荐恢复点的要求。


153-156: LGTM!下一步计划合理且具体。

"下一步"部分提供了清晰的后续行动指引:

  1. 重新计算 branch diff 以确认是否还有扩批空间
  2. 重新抓取 PR review 确认 open thread 状态
  3. 若继续扩批,提供了具体的低风险方向选择建议

计划具有可操作性,符合 tracking 文件应记录下一推荐步骤的要求。

GFramework.Godot.SourceGenerators.Abstractions/README.md (1)

46-51: 所有"继续阅读"中的相对路径链接均已验证存在且有效,无需修改。

Comment thread docs/zh-CN/source-generators/index.md Outdated
Comment thread tools/gframework-config-tool/README.md
- 优化源码生成器总览页的共享支撑模块说明句式

- 更新 config tool README,补充中文接入文档入口

- 记录 PR #292 最新 review 状态与验证结果
@GeWuYou GeWuYou changed the title Docs/sdk update documentation docs: clarify meta-package scope, source generator contracts, and add Game config tool documentation Apr 25, 2026
@github-actions
Copy link
Copy Markdown

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
2156 2156 0 0 0 0 35.5s    ↓208ms

Test Results

passed 2156 passed

Details

tests 2156 tests
clock 35.5s ↓208ms
tool nunit
build CI - Build & Test arrow-right build-and-test link #978
pull-request docs: clarify meta-package scope, source generator contracts, and add Game config tool documentation link #292

Insights

Average Tests per Run Total Flaky Tests Total Failed Slowest Test (p95)
2145 0 0 5.4s

build-and-test: Run #978

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Pending ⏳ Other ❓ Flaky 🍂 Duration ⏱️
2156 2156 0 0 0 0 0 35.5s

🎉 All tests passed!

Slowest Tests

Test 📝 Results 📊 Duration (avg) ⏱️ Duration (p95) ⏱️
Does_Not_Report_When_FieldInjectedModel_Is_Registered 31 2.4s 5.4s
SendRequestAsync_Should_ResolveCqrsRuntime_OnlyOnce_When_AccessedConcurrently 31 4.3s 4.8s
Generates_Scene_Behavior_Boilerplate 31 2.0s 4.6s
Context_Caching_Should_Improve_Performance 31 802ms 1.1s
CleanupDuringAcquire_Should_NotCauseRaceCondition 31 1.1s 1.1s
Append_ShouldNotBlock 31 1.0s 1.0s
RegisterCqrsHandlersFromAssembly_Should_Deduplicate_Repeated_Assembly_Registration 31 230ms 791ms
ConfigModuleCanRunDuringArchitectureInitialization 31 215ms 550ms
PendingCount_ShouldReflectQueuedEntries 31 501ms 501ms
Cleanup_Should_NotRemoveActiveLocks 31 404ms 406ms

± Comparison with run #976 at 1eb39b9 | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 31 runs.

Github Test Reporter by CTRF 💚

@GeWuYou
Copy link
Copy Markdown
Owner Author

GeWuYou commented Apr 25, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@GeWuYou GeWuYou enabled auto-merge April 25, 2026 14:05
@GeWuYou
Copy link
Copy Markdown
Owner Author

GeWuYou commented Apr 25, 2026

@@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

@GeWuYou 好的,我将立即对此 PR 进行审查!


🧠 Learnings used
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

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
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
tools/gframework-config-tool/README.md (1)

5-31: 建议补一段“最小接入路径(Quick Start)”以完成 README 采用闭环。

现在有 Purpose、布局和设置,但还缺一步到位的最小接入步骤(例如:安装扩展 → 配置 configPath/schemasPath → 打开 Explorer 并执行一次验证/表单预览)。建议补 3~5 步的最短路径,降低首次接入门槛。

✏️ 可选补充示例
 ## Workspace Settings
 
 ```json
 {
   "gframeworkConfig.configPath": "config",
   "gframeworkConfig.schemasPath": "schemas"
 }

+## Quick Start (Minimum Adoption Path)
+
+1. 安装 GFramework Config Tool 扩展并在 VS Code 打开游戏项目根目录。
+2. 确认项目包含 config/schemas/(目录示例见上文)。
+3. 在工作区设置中配置 gframeworkConfig.configPathgframeworkConfig.schemasPath
+4. 在 Explorer View 打开一个配置域,执行一次 validation。
+5. 对单文件使用 lightweight form preview;涉及复杂结构时回退到 raw YAML 编辑。

</details>

As per coding guidelines, "`**/README.md`: A module README MUST describe ... minimum adoption path, and corresponding docs/zh-CN/ entry points".


Also applies to: 73-80

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @tools/gframework-config-tool/README.md around lines 5 - 31, README is
missing a "Quick Start (Minimum Adoption Path)" section; add a short 3–5 step
Quick Start showing installation and the minimal actions to get the extension
working: 1) install/open the "GFramework Config Tool" in VS Code at the game
project root, 2) ensure config/ and schemas/ exist (as shown in the layout), 3)
set workspace settings gframeworkConfig.configPath and
gframeworkConfig.schemasPath, 4) open a config file in Explorer and run
validation, and 5) use the lightweight form preview for single files (fallback
to raw YAML for complex edits); include these steps under a new "Quick Start
(Minimum Adoption Path)" heading in README.md and mention the two settings keys
so docs/zh-CN/ can mirror the same entry.


</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>🤖 Prompt for all review comments with AI agents</summary>

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @tools/gframework-config-tool/README.md:

  • Around line 64-65: The README uses two inconsistent phrases ("stable subset"
    and "current schema subset"); pick one term (e.g., "stable config-schema subset"
    or "current schema subset") and replace all occurrences in the README so the
    wording is consistent (including the instances matching "stable subset" and
    "current schema subset" around the previously noted paragraphs). Update any
    nearby explanatory text to reflect the chosen term and ensure the same phrase is
    used throughout the document.

Nitpick comments:
In @tools/gframework-config-tool/README.md:

  • Around line 5-31: README is missing a "Quick Start (Minimum Adoption Path)"
    section; add a short 3–5 step Quick Start showing installation and the minimal
    actions to get the extension working: 1) install/open the "GFramework Config
    Tool" in VS Code at the game project root, 2) ensure config/ and schemas/ exist
    (as shown in the layout), 3) set workspace settings gframeworkConfig.configPath
    and gframeworkConfig.schemasPath, 4) open a config file in Explorer and run
    validation, and 5) use the lightweight form preview for single files (fallback
    to raw YAML for complex edits); include these steps under a new "Quick Start
    (Minimum Adoption Path)" heading in README.md and mention the two settings keys
    so docs/zh-CN/ can mirror the same entry.

</details>

<details>
<summary>🪄 Autofix (Beta)</summary>

Fix all unresolved CodeRabbit comments on this PR:

- [ ] <!-- {"checkboxId": "4b0d0e0a-96d7-4f10-b296-3a18ea78f0b9"} --> Push a commit to this branch (recommended)
- [ ] <!-- {"checkboxId": "ff5b1114-7d8c-49e6-8ac1-43f82af23a33"} --> Create a new PR with the fixes

</details>

---

<details>
<summary>ℹ️ Review info</summary>

<details>
<summary>⚙️ Run configuration</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro

**Run ID**: `72366214-2ca3-4728-8670-e4346ff985a3`

</details>

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between b96565ffa367bade30f44c2d4e8955143fbff85e and d3d62cf4541063c46458f88eea0f5acd1b4503f9.

</details>

<details>
<summary>📒 Files selected for processing (4)</summary>

* `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`
* `ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md`
* `docs/zh-CN/source-generators/index.md`
* `tools/gframework-config-tool/README.md`

</details>

<details>
<summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary>

* ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md

</details>

</details>

<details>
<summary>📜 Review details</summary>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (8)</summary>

<details>
<summary>ai-plan/public/**</summary>


**📄 CodeRabbit inference engine (AGENTS.md)**

> `ai-plan/public/**`: Contributors MUST keep committed `ai-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/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>ai-plan/**</summary>


**📄 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/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>ai-plan/public/*/todos/**</summary>


**📄 CodeRabbit inference engine (AGENTS.md)**

> `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
> 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
> 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`

</details>
<details>
<summary>**/README.md</summary>


**📄 CodeRabbit inference engine (AGENTS.md)**

> `**/README.md`: Use the canonical filename `README.md` (not `ReadMe.md` or 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's `README.md` in the same change
> Update the relevant `README.md` or `docs/` page when behavior, setup steps, architecture guidance, or user-facing examples change

Files:
- `tools/gframework-config-tool/README.md`

</details>
<details>
<summary>docs/**/*.md</summary>


**📄 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/source-generators/index.md`

</details>
<details>
<summary>{README.md,docs/**}</summary>


**📄 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/source-generators/index.md`

</details>
<details>
<summary>docs/**</summary>


**📄 CodeRabbit inference engine (AGENTS.md)**

> `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
> 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/source-generators/index.md`

</details>
<details>
<summary>docs/zh-CN/**</summary>


**📄 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/source-generators/index.md`

</details>

</details><details>
<summary>🧠 Learnings (26)</summary>

<details>
<summary>📓 Common learnings</summary>

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


Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-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


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


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


</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`
- `tools/gframework-config-tool/README.md`
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-17T11:35:08.762Z</summary>

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:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`
- `tools/gframework-config-tool/README.md`
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`
- `tools/gframework-config-tool/README.md`
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`
- `tools/gframework-config-tool/README.md`
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-25T03:13:31.756Z
Learning: Contributors MUST NOT treat a repeated incremental dotnet build result as authoritative for warning inspection when a clean baseline has not been captured


**Applied to files:**
- `ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `tools/gframework-config-tool/README.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `tools/gframework-config-tool/README.md`
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `tools/gframework-config-tool/README.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `tools/gframework-config-tool/README.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `tools/gframework-config-tool/README.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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 avoid rhetorical, self-referential, or AI-sounding headings and prompts, preferring neutral labels


**Applied to files:**
- `tools/gframework-config-tool/README.md`
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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:**
- `tools/gframework-config-tool/README.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.755Z</summary>

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:**
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.755Z</summary>

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:**
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.755Z</summary>

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:**
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.755Z</summary>

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:**
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.755Z</summary>

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:**
- `docs/zh-CN/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-25T03:13:31.756Z</summary>

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/source-generators/index.md`

</details>
<details>
<summary>📚 Learning: 2026-04-16T13:26:01.780Z</summary>

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/source-generators/index.md`

</details>

</details><details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>docs/zh-CN/source-generators/index.md</summary>

[uncategorized] ~34-~34: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:新"地"安装
Context: ...`[AutoScene]`、`[AutoUiPage]`。  这些目录当前不是新的安装入口。对读者更重要的是先判断:  - 应该安装哪个 `*.SourceGen...

(wb4)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (2)</summary><blockquote>

<details>
<summary>docs/zh-CN/source-generators/index.md (1)</summary><blockquote>

`23-39`: **共享支撑层定位说明清晰,读者决策路径明确。**

这一段把“可安装包”与“内部支撑模块”边界讲清楚了,也给了排查 attribute/diagnostics 时的回查路径,和本次 PR 目标一致。  



Also applies to: 75-80

</blockquote></details>
<details>
<summary>ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md (1)</summary><blockquote>

`15-23`: **跟踪文档更新完整,恢复点与验证链路可追溯。**

本次更新把“状态—验证—下一步”闭环补齐了,便于后续接力与回溯。  



Also applies to: 72-105, 158-160

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Comment thread tools/gframework-config-tool/README.md Outdated
- 补充 config tool README 的 Quick Start 最小接入步骤并统一 schema subset 术语
- 更新 documentation-full-coverage-governance 的 tracking 与 trace,记录 PR #292 最新 review 结论和验证结果
- 补充工具模块的测试与 VSIX 打包验证结果,作为本轮 review 收口的最小验证证据
@github-actions
Copy link
Copy Markdown

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
2156 2156 0 0 0 0 36.6s    ↑1.0s

Test Results

passed 2156 passed

Details

tests 2156 tests
clock 36.6s ↑1.0s
tool nunit
build CI - Build & Test arrow-right build-and-test link #981
pull-request docs: clarify meta-package scope, source generator contracts, and add Game config tool documentation link #292

Insights

Average Tests per Run Total Flaky Tests Total Failed Slowest Test (p95)
2145 0 0 5.4s

build-and-test: Run #981

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Pending ⏳ Other ❓ Flaky 🍂 Duration ⏱️
2156 2156 0 0 0 0 0 36.6s

🎉 All tests passed!

Slowest Tests

Test 📝 Results 📊 Duration (avg) ⏱️ Duration (p95) ⏱️
Does_Not_Report_When_FieldInjectedModel_Is_Registered 32 2.4s 5.4s
SendRequestAsync_Should_ResolveCqrsRuntime_OnlyOnce_When_AccessedConcurrently 32 4.3s 4.8s
Generates_Scene_Behavior_Boilerplate 32 2.0s 4.6s
Context_Caching_Should_Improve_Performance 32 802ms 1.1s
CleanupDuringAcquire_Should_NotCauseRaceCondition 32 1.1s 1.1s
Append_ShouldNotBlock 32 1.0s 1.0s
RegisterCqrsHandlersFromAssembly_Should_Deduplicate_Repeated_Assembly_Registration 32 229ms 791ms
ConfigModuleCanRunDuringArchitectureInitialization 32 214ms 550ms
PendingCount_ShouldReflectQueuedEntries 32 501ms 501ms
Cleanup_Should_NotRemoveActiveLocks 32 404ms 406ms

± Comparison with run #978 at 821667c | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 32 runs.

Github Test Reporter by CTRF 💚

@GeWuYou GeWuYou merged commit 3446896 into main Apr 26, 2026
7 checks passed
@GeWuYou GeWuYou deleted the docs/sdk-update-documentation branch April 26, 2026 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant