docs(sdk): 更新文档规范并添加VitePress配置#250
Conversation
- 调整文档真实性原则，以源码和测试为首要证据源 - 新增模块README要求，规定所有用户包必须有说明文档 - 更新仓库文档规范，要求根README与文档站点分类一致 - 添加VitePress配置文件，支持中文搜索和泛型转义 - 创建入门指南文档，说明GFramework模块组成和接入路径 - 添加快速开始教程，演示Core模块最小使用示例 - 为Core模块添加详细README文档 - 为Core.Abstractions添加契约层说明文档 - 为Core.SourceGenerators添加源码生成器文档 - 为Game模块添加运行时层详细说明文档
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📜 Recent 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). (2)
📝 WalkthroughWalkthrough本次变更大规模重构与补充仓库文档：新增与重写多个模块级 README、调整根 README 与文档站导航、引入“Documentation Source Of Truth”规则与模块 README 要求，并重写入门/快速开始为以模块选型和最小接入路径为主的内容。变更均为文档内容更新，无代码 API 更改。 Changes
Sequence Diagram(s)（该变更为文档重组/新增，未引入新的多组件运行时交互或可视化流程，故省略序列图。） 预计审查工作量🎯 3 (中等) | ⏱️ ~25 分钟 可能相关的 PR
总览本次变更对 GFramework 仓库的文档进行了全面重组，重新定义了各模块的定位（运行时 vs 抽象层 vs 源生成器），补充了包关系地图、子系统地图和最小接入路径，更新了文档站导航，并调整了入门指南的内容结构。 变更清单
预计审查工作量🎯 3 (中等) | ⏱️ ~25 分钟 可能相关的 PR
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![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
🤖 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/abstractions/index.md`:
- Line 20: The sentence in docs/zh-CN/abstractions/index.md containing
“真正的安装和采用路径” is awkward; update that phrase to “实际安装与接入路径” so the full line
reads: “抽象层页面会解释接口分组与职责；实际安装与接入路径，仍应以运行时模块 README 与 `getting-started` 为主。”.
🪄 Autofix (Beta)
✅ Autofix completed
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 275f688e-a8d7-4895-8bf7-294ab8472980
📒 Files selected for processing (15)
AGENTS.mdGFramework.Core.Abstractions/README.mdGFramework.Core.SourceGenerators/README.mdGFramework.Core/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Cqrs.SourceGenerators/README.mdGFramework.Cqrs/README.mdGFramework.Game.Abstractions/README.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdREADME.mddocs/.vitepress/config.mtsdocs/zh-CN/abstractions/index.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/getting-started/quick-start.md
📜 Review details
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Build and Test
- GitHub Check: Code Quality & Security
- GitHub Check: Analyze (C#)
🧰 Additional context used
📓 Path-based instructions (5)
**/README.md
📄 CodeRabbit inference engine (AGENTS.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
Files:
GFramework.Core.Abstractions/README.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdGFramework.Game.Abstractions/README.mdGFramework.Cqrs.SourceGenerators/README.mdGFramework.Core/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Core.SourceGenerators/README.mdGFramework.Cqrs/README.mdREADME.md
**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Update the relevant
README.mdordocs/page when behavior, setup steps, architecture guidance, or user-facing examples change
Files:
GFramework.Core.Abstractions/README.mddocs/zh-CN/abstractions/index.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdGFramework.Game.Abstractions/README.mdAGENTS.mdGFramework.Cqrs.SourceGenerators/README.mdGFramework.Core/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Core.SourceGenerators/README.mddocs/zh-CN/getting-started/index.mdGFramework.Cqrs/README.mdREADME.mddocs/zh-CN/getting-started/quick-start.md
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/abstractions/index.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/getting-started/quick-start.md
docs/zh-CN/**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
When a feature is added, removed, renamed, or substantially refactored, contributors MUST update or create the corresponding user-facing integration documentation in
docs/zh-CN/in the same change
Files:
docs/zh-CN/abstractions/index.mddocs/zh-CN/getting-started/index.mddocs/zh-CN/getting-started/quick-start.md
README.md
📄 CodeRabbit inference engine (AGENTS.md)
The repository root
README.mdMUST mirror the current top-level documentation taxonomy used by the docs site and prefer linking to section landing pages instead of deep-linking
Files:
README.md
🧠 Learnings (27)
📓 Common learnings
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.735Z
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-16T11:55:23.932Z
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-16T11:55:23.932Z
Learning: Applies to docs/zh-CN/**/* : For integration-oriented features such as the AI-First config system, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes when behavior changes
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Before choosing runtimes or CLI tools, read `@.ai/environment/tools.ai.yaml` and use project-relevant tools listed there instead of assuming every installed system tool is fair game
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: When working in WSL against this repository's Windows-backed worktree, prefer Windows Git from WSL (for example `git.exe`) instead of the Linux `git` binary
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Use subagents only when the task is complex, the context is likely to grow too large, or the work can be split into independent parallel subtasks, and the main agent MUST identify the critical path first
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Every non-trivial feature, bug fix, or behavior change MUST include tests or an explicit justification for why a test is not practical
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Public API changes must be covered by unit or integration tests
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: When a public API defines multiple contract branches, tests MUST cover the meaningful variants, including null, empty, default, and filtered inputs when those branches change behavior
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Regression fixes should include a test that fails before the fix and passes after it
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Keep tests focused on observable behavior, not implementation trivia
Learnt from: CR
Repo: GeWuYou/GFramework
Timestamp: 2026-04-18T02:09:04.458Z
Learning: Every user-facing package or module directory that contains a `*.csproj` intended for direct consumption MUST have a sibling `README.md` using the canonical filename
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
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.mtsGFramework.Core.Abstractions/README.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mdGFramework.Game.Abstractions/README.mdAGENTS.mdGFramework.Core/README.mdGFramework.Cqrs.Abstractions/README.mddocs/zh-CN/getting-started/index.mdGFramework.Cqrs/README.mdREADME.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to docs/zh-CN/**/* : For integration-oriented features such as the AI-First config system, documentation MUST cover: project directory layout and file conventions, required project or package wiring, minimal working usage example, and migration or compatibility notes when behavior changes
Applied to files:
docs/.vitepress/config.mtsGFramework.Core.Abstractions/README.mddocs/zh-CN/abstractions/index.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdGFramework.Game.Abstractions/README.mdAGENTS.mdGFramework.Core/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Core.SourceGenerators/README.mddocs/zh-CN/getting-started/index.mdGFramework.Cqrs/README.mdREADME.mddocs/zh-CN/getting-started/quick-start.md
📚 Learning: 2026-04-17T11:35:08.735Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.735Z
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.mtsdocs/zh-CN/abstractions/index.mdGFramework.Game.SourceGenerators/README.mdGFramework.Game/README.mdAGENTS.mdGFramework.Core/README.mddocs/zh-CN/getting-started/index.mdREADME.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
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.Core.Abstractions/README.mdGFramework.Game.Abstractions/README.mdAGENTS.mdGFramework.Core/README.mdGFramework.Cqrs.Abstractions/README.mdGFramework.Core.SourceGenerators/README.md
📚 Learning: 2026-04-17T11:35:08.735Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.735Z
Learning: Applies to **/*Abstractions/**/*.cs : Abstractions projects should only contain interfaces and contract definitions without any runtime implementation logic
Applied to files:
GFramework.Core.Abstractions/README.mddocs/zh-CN/abstractions/index.md
📚 Learning: 2026-04-16T11:55:23.931Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.931Z
Learning: Applies to **/*.cs : Core framework components such as Architecture, Module, System, Context, Registry, Service Module, and Lifecycle types MUST include high-level explanations of responsibilities, lifecycle, interaction with other components, why the abstraction exists, and when to use it instead of alternatives
Applied to files:
GFramework.Core.Abstractions/README.mdAGENTS.mdGFramework.Core/README.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to docs/zh-CN/**/* : Do not rely on "the code is self-explanatory" for framework features that consumers need to adopt; write the adoption path down so future users do not need to rediscover it from source
Applied to files:
GFramework.Core.Abstractions/README.mddocs/zh-CN/abstractions/index.mdGFramework.Game/README.mdAGENTS.mdGFramework.Core/README.mddocs/zh-CN/getting-started/index.mdREADME.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to **/*.SourceGenerators.cs : When generator behavior changes intentionally, update snapshots together with the implementation
Applied to files:
GFramework.Game.SourceGenerators/README.mdGFramework.Cqrs.SourceGenerators/README.mdGFramework.Core.SourceGenerators/README.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to **/*.SourceGenerators.Tests.cs : Source generator changes MUST be covered by generator tests
Applied to files:
GFramework.Game.SourceGenerators/README.mdGFramework.Cqrs.SourceGenerators/README.mdGFramework.Core.SourceGenerators/README.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to **/*.SourceGenerators.cs : Keep source generators deterministic and free of hidden environment or network dependencies
Applied to files:
GFramework.Game.SourceGenerators/README.mdGFramework.Cqrs.SourceGenerators/README.mdGFramework.Core.SourceGenerators/README.md
📚 Learning: 2026-04-16T11:55:23.931Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.931Z
Learning: Applies to **/*.cs : Generated logic and generator pipelines MUST explain what is generated, why it is generated, the semantic assumptions the generator relies on, and any diagnostics or fallback behavior
Applied to files:
GFramework.Game.SourceGenerators/README.mdGFramework.Cqrs.SourceGenerators/README.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to {README.md,docs/**/*} : Update the relevant `README.md` or `docs/` page when behavior, setup steps, architecture guidance, or user-facing examples change
Applied to files:
AGENTS.mddocs/zh-CN/getting-started/index.mdREADME.md
📚 Learning: 2026-04-17T11:35:08.735Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.735Z
Learning: All coding rules must be followed strictly as defined in AGENTS.md
Applied to files:
AGENTS.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to {README.md,docs/**/*} : If an existing documentation page no longer reflects the current implementation, fixing the code without fixing the documentation is considered incomplete work
Applied to files:
AGENTS.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
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:
AGENTS.mdGFramework.Core/README.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to local-plan/**/* : 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:
AGENTS.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to {README.md,docs/**/*} : Keep code samples, package names, and command examples aligned with the current repository state in documentation
Applied to files:
AGENTS.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to local-plan/todos/**/* : For any multi-step refactor, migration, or cross-module task, contributors MUST create or adopt a dedicated recovery document under `local-plan/todos/` before making substantive code changes
Applied to files:
AGENTS.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to local-plan/todos/**/* : When working from a tracked implementation plan, contributors MUST update the corresponding tracking document under `local-plan/todos/` in the same change
Applied to files:
AGENTS.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to {README.md,docs/**/*} : Prefer documenting behavior and design intent, not only API surface in documentation
Applied to files:
AGENTS.md
📚 Learning: 2026-04-17T11:35:08.735Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.735Z
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:
GFramework.Cqrs.SourceGenerators/README.md
📚 Learning: 2026-04-17T11:35:08.735Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-17T11:35:08.735Z
Learning: Applies to **/Cqrs/**/*.cs : Use CQRS (Command Query Responsibility Segregation) pattern with the Cqrs naming entry point instead of the historical Mediator alias
Applied to files:
GFramework.Cqrs/README.md
📚 Learning: 2026-04-06T12:45:47.739Z
Learnt from: GeWuYou
Repo: GeWuYou/GFramework PR: 190
File: GFramework.Game/Config/GameConfigBootstrap.cs:1-3
Timestamp: 2026-04-06T12:45:47.739Z
Learning: In the GFramework repository (GeWuYou/GFramework), even though `ImplicitUsings` is disabled in the `.csproj` files, the project uses a manual `GlobalUsings.cs` file with `global using` directives to provide common System namespaces (e.g., System, System.Threading, System.Threading.Tasks) project-wide. Do not flag missing System-level `using` imports in C# files within this repository, as they are covered by GlobalUsings.cs.
Applied to files:
README.md
📚 Learning: 2026-04-16T13:25:59.124Z
Learnt from: GeWuYou
Repo: GeWuYou/GFramework PR: 235
File: GFramework.SourceGenerators.Tests/Rule/ContextAwareGeneratorSnapshotTests.cs:1-3
Timestamp: 2026-04-16T13:25:59.124Z
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:
README.md
📚 Learning: 2026-04-16T11:55:23.932Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.932Z
Learning: Applies to **/*.cs : Use the namespace pattern `GFramework.{Module}.{Feature}` with PascalCase segments
Applied to files:
README.md
📚 Learning: 2026-04-16T11:55:23.931Z
Learnt from: CR
Repo: GeWuYou/GFramework PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-16T11:55:23.931Z
Learning: Applies to **/*.csproj : Follow the repository defaults with `ImplicitUsings` disabled, `Nullable` enabled, `GenerateDocumentationFile` enabled for shipped libraries, and `LangVersion` generally `preview` in the main libraries and abstractions
Applied to files:
README.md
🪛 LanguageTool
docs/zh-CN/abstractions/index.md
[uncategorized] ~20-~20: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：真正"地"安装
Context: ...*.Abstractions 包。 - 抽象层页面会解释接口分组与职责；真正的安装和采用路径，仍应以运行时模块 README 与 `getting-start...
(wb4)
GFramework.Game/README.md
[uncategorized] ~30-~30: 您的意思是“"不"齐”？
Context: ...ramework.Game`，生成时代码由 source generators 补齐。 - 引擎适配包或项目内适配层 - 本包提供的是“引擎无关”的核心逻辑和...
(BU)
[uncategorized] ~144-~144: 您的意思是“由"于"”吗？
Context: ...ISceneFactory、ISceneRoot - 提供栈式场景路由与转换处理管道 -UiRouterBase - 依赖IUiFacto...
(YU7_YU8)
[uncategorized] ~284-~284: 您的意思是“"不"齐”？
Context: .../ UI 路由 这里的最小前提不是“直接 new 一个 router”，而是先补齐运行时依赖： - ISceneFactory / `IUiFactory...
(BU)
GFramework.Game.Abstractions/README.md
[uncategorized] ~213-~213: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：真正"地"实现
Context: ...EnterParam -IUiPageEnterParam- 真正的实现和装配则放在： -GFramework.Game -GFr...
(wb4)
GFramework.Core/README.md
[grammar] ~66-~66: Ensure spelling is correct
Context: ...继承 Architecture 2. 在 OnInitialize() 中注册模型、系统、工具或模块 3. 通过 architecture.Context 或 `Context...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
GFramework.Cqrs/README.md
[uncategorized] ~143-~143: 您的意思是“"不"齐”？
Context: ...ore` 架构初始化路径，这些步骤通常由框架自动完成；裸容器或测试环境则需要显式补齐 runtime 与注册入口。 ## 适用边界 - 这个包是默认实现，不是...
(BU)
README.md
[style] ~5-~5: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2513 characters long)
Context: ...t.org/packages/GeWuYou.GFramework.Core) 
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~25-~25: Ensure spelling is correct
Context: ...README | | GFramework.Cqrs.Abstractions | CQRS 消息、处理器、pipeline 行为...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~25-~25: Ensure spelling is correct
Context: ...| CQRS 消息、处理器、pipeline 行为等契约 | [README](GFramework.Cqrs.Abstractions/README.md) | |GFramework...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~32-~32: Ensure spelling is correct
Context: ...rk.Game.SourceGenerators/README.md) | | GFramework.Cqrs.SourceGenerators | CQRS handler regist...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~32-~32: Ensure spelling is correct
Context: ...s| CQRS handler registry 生成器 | [README](GFramework.Cqrs.SourceGenerators/README.md) | |GFrame...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (14)
docs/.vitepress/config.mts (1)
119-119: 导航新增“抽象接口”入口合理且与侧边栏一致。该改动与同文件内
/zh-CN/abstractions/侧边栏分组对齐，信息架构一致。docs/zh-CN/getting-started/index.md (1)
1-107: 入门页重构方向正确，接入路径信息完整。问题导向结构清晰，模块选型、最小落地路径和阅读顺序都可直接指导新用户接入。
Based on learnings: “Do not rely on "the code is self-explanatory" for framework features that consumers need to adopt; write the adoption path down so future users do not need to rediscover it from source”.
GFramework.Cqrs.Abstractions/README.md (1)
1-101: README 结构完整，契约层边界描述清晰。模块定位、相邻包关系、子系统地图、最小接入路径和文档入口都覆盖到了，便于消费者快速判断是否仅依赖 abstractions。
As per coding guidelines: “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”.GFramework.Core.Abstractions/README.md (1)
3-51: 抽象层 README 重构到位，信息密度和可执行性都很好。契约地图和采用建议很实用，能显著降低“只需契约 vs 需要运行时实现”的选型成本。
As per coding guidelines: “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”.GFramework.Game.Abstractions/README.md (1)
3-240: 内容组织清晰，契约包边界表达准确。“最小接入路径 + 何时升级到 runtime 包”的分层说明非常实用，能直接指导依赖策略。
As per coding guidelines: “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”.GFramework.Core/README.md (1)
3-84: Core 模块 README 的“职责边界 + 接入顺序”表达很清楚。对“负责什么/不负责什么”的拆分很有效，能减少错误期望并加速新项目接入。
GFramework.Game/README.md (1)
124-124: 该链接的文件名大小写已准确。 仓库中实际文件为ReadMe.md（混合大小写），README 中的链接./Storage/ReadMe.md已正确指向该文件。无需更改。> Likely an incorrect or invalid review comment.AGENTS.md (1)
240-310: 文档治理规则补充清晰且可执行。这部分把“证据优先级、模块 README 必备项、根 README 与站点分类对齐、任务追踪要求”写得足够具体，能直接指导后续文档变更落地。
GFramework.Game.SourceGenerators/README.md (1)
1-70: 模块 README 结构完整，符合新规范。模块定位、包关系、目录与输入约定、最小接入路径和文档入口都已覆盖，信息密度和可执行性都不错。
GFramework.Core.SourceGenerators/README.md (1)
1-95: 重构后的 README 定位更统一。从“能力碎片说明”转成“模块级入口文档”后，可读性和检索性都更好，且接入路径与文档入口都给到了。
GFramework.Cqrs.SourceGenerators/README.md (1)
1-67: CQRS 生成器 README 信息准确且落地。“生成优先 + 回退反射”的语义、最小接入方式和运行时接法都写清楚了，作为模块入口文档是合格的。
README.md (1)
12-52: 根 README 与文档站点导航已成功对齐。栏目命名、入口分层和贡献说明现在是一致的，能明显降低“仓库入口”和“文档站入口”之间的认知跳转成本。
Also applies to: 132-137
docs/zh-CN/getting-started/quick-start.md (1)
3-5: 快速开始页改得很实用。“最小依赖 → 最小架构 → 最小命令执行链路”的路径清晰，且明确提示了后续迁移到 CQRS 的阅读入口。
Also applies to: 7-105
GFramework.Cqrs/README.md (1)
5-153: CQRS 模块 README 覆盖面完整。定位、子系统地图、运行时行为与注册语义都说明到位，能支持“先接入再深挖”的使用路径。
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Fixes Applied SuccessfullyFixed 1 file(s) based on 1 unresolved review comment. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 1 file(s) based on 1 unresolved review comment. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
1 participant
Summary by CodeRabbit