Docs/sdk update documentation#303
Conversation
- 更新 Game / Godot 细页的交叉链接与边界描述，移除内部路径、旧文档对比和命令式跳转 - 更新 GFramework.Godot 与配置工具 README 的公开标签，避免暴露测试路径和原始文档路径 - 补充 documentation-full-coverage-governance 的 RP-049 恢复点、验证结果与 origin/main stop-condition 计量
- 更新 Game 数据与存储页面、Godot UI 页面中的 reader-facing 说明，移除内部证据口吻、外部项目指代和生硬导流 - 更新 CQRS 抽象层与 SourceGenerators.Common README 的标签表述，避免暴露源文件路径列表和实现级打包术语 - 补充 documentation-full-coverage-governance 的 RP-050 恢复点、验证结果与 origin/main stop-condition 计量
|
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 (18)
📜 Recent review details🧰 Additional context used📓 Path-based instructions (7)**/README.md📄 CodeRabbit inference engine (AGENTS.md)
Files:
docs/**/*.md📄 CodeRabbit inference engine (CLAUDE.md)
Files:
{README.md,docs/**}📄 CodeRabbit inference engine (AGENTS.md)
Files:
docs/zh-CN/**📄 CodeRabbit inference engine (AGENTS.md)
Files:
docs/**📄 CodeRabbit inference engine (AGENTS.md)
Files:
ai-plan/public/*/traces/**📄 CodeRabbit inference engine (AGENTS.md)
Files:
ai-plan/public/*/todos/**📄 CodeRabbit inference engine (AGENTS.md)
Files:
🧠 Learnings (35)📓 Common learnings📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-17T11:35:08.762ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-16T13:26:01.780ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-06T12:45:47.739ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-17T11:35:08.762ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
📚 Learning: 2026-04-26T03:16:48.230ZApplied to files:
🪛 LanguageTooldocs/zh-CN/godot/ui.md[uncategorized] ~300-~300: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：强"地"输入 (wb4) ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md[grammar] ~10-~10: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~50-~50: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md[grammar] ~22-~22: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~29-~29: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~29-~29: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~73-~73: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) 🔇 Additional comments (22)
📝 Walkthrough总体说明此PR更新了多个README和中文文档，将具体的文件路径引用替换为接口/类型名称，调整导航文本措辞，并移除过时的内部实现细节参考，不涉及代码逻辑改动。 变更详情
评估代码审查工作量🎯 1 (Trivial) | ⏱️ ~8 minutes 可能相关的PR
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
|
| Filename | Overview |
|---|---|
| GFramework.Cqrs.Abstractions/README.md | Interface listings replaced with type-level generic names (e.g., IRequest<TResponse>) instead of raw source file paths — aligns with AGENTS.md requirement to avoid surfacing raw filenames as navigation text. |
| GFramework.Godot/README.md | Removed raw test file path from reader-facing text, keeping only the factual statement about the tested boundary. |
| GFramework.SourceGenerators.Common/README.md | Replaced IsPackable=false implementation detail with reader-facing installation guidance, removing a build-property term that would be opaque to NuGet consumers. |
| docs/zh-CN/godot/ui.md | Replaced internal "CoreGrid" project-specific references with generic reader-facing phrasing; removed "真实消费者 wiring" governance language. |
| docs/zh-CN/godot/signal.md | Removed "旧文档" reference and migration chain framing; simplified boundary section to state the current public API entry point directly. |
| ai-plan/public/documentation-full-coverage-governance/todos/documentation-full-coverage-governance-tracking.md | Recovery point advanced to RP-050; status summary and next steps updated to reflect the upstream branch being gone and the new origin/main baseline strategy. |
| ai-plan/public/documentation-full-coverage-governance/traces/documentation-full-coverage-governance-trace.md | New RP-049 and RP-050 trace sections added with decisions, validation results, and next steps for the two batch rounds performed on 2026-04-29. |
| tools/gframework-config-tool/README.md | Raw file path labels in the Documentation section replaced with Chinese reader-facing titles ("Game 配置工具", "Game 配置系统"). |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR: Docs/sdk update documentation] --> B[README cleanups]
A --> C[docs/zh-CN page cleanups]
A --> D[ai-plan tracking updates]
B --> B1[GFramework.Cqrs.Abstractions/README.md\nFile paths to type-level API names]
B --> B2[GFramework.Godot/README.md\nRemove raw test path reference]
B --> B3[GFramework.SourceGenerators.Common/README.md\nIsPackable detail to reader-facing install note]
B --> B4[tools/gframework-config-tool/README.md\nRaw path labels to semantic titles]
C --> C1[godot/ui.md\nRemove CoreGrid internal refs]
C --> C2[godot/signal.md\nRemove old-docs refs]
C --> C3[godot/storage, setting, logging, index\nReplace imperative nav with neutral phrasing]
C --> C4[game/data, storage, scene, config-system\nRemove internal path and governance refs]
C --> C5[core/index.md, ecs/arch.md\nNeutral navigation language]
D --> D1[todos tracking\nRP-048 to RP-050]
D --> D2[traces\nAdd RP-049 and RP-050 entries]
Reviews (1): Last reviewed commit: "docs(documentation-governance): 收口数据与 UI..." | Re-trigger Greptile
Summary
Test Results
Details
Insights
build-and-test: Run #1012
🎉 All tests passed!Slowest Tests
± Comparison with run #1002 at df49d26 | 🎉 No failed tests detected across all runs. | 🍂 No flaky tests detected across all runs. | ⏱️ Measured over 38 runs. Github Test Reporter by CTRF 💚 |
✅MegaLinter analysis: Success
See detailed reports in MegaLinter artifacts
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
1 participant
Summary by CodeRabbit
发布说明