docs(config): 更新文档导航结构并添加新章节#87
Merged
Merged
Conversation
- 添加最佳实践导航菜单和相关页面链接 - 在核心模块侧边栏增加生命周期、CQRS模式、协程系统等新条目 - 为游戏模块添加数据管理、场景系统、UI系统等功能链接 - 在Godot集成部分新增暂停系统、对象池和日志系统文档 - 将规则生成器重命名为ContextAware生成器 - 在教程部分增加暂停系统实践、数据迁移和单元测试等内容 - 新增API参考、常见问题、故障排查等文档分类 - 为最佳实践页面配置详细的子菜单项
审阅者指南在 VitePress 中更新中文文档导航，引入新的“最佳实践”板块，扩展 core、game、Godot 和 tutorials 的侧边栏，并新增包括 API 参考和其他支持文档在内的顶级和分组菜单项，同时将规则源码生成器条目重命名为 ContextAware 生成器。 更新后的 zh-CN 文档导航结构流程图flowchart TD
Root[zhCN documentation navigation]
Root --> TopNav[Top navigation]
Root --> Sidebars[Sidebars by section]
%% Top navigation items
TopNav --> NavCore[Core 核心]
TopNav --> NavGame[Game 游戏]
TopNav --> NavGodot[Godot]
TopNav --> NavSourceGenerators[源码生成器]
TopNav --> NavTutorials[教程]
TopNav --> NavBestPractices[最佳实践]
TopNav --> NavMore[更多 下拉菜单]
NavMore --> MoreAPIReference[API 参考]
NavMore --> MoreFAQ[常见问题]
NavMore --> MoreTroubleshooting[故障排查]
NavMore --> MoreMigrationGuide[迁移指南]
NavMore --> MoreContributing[贡献指南]
%% Core sidebar
Sidebars --> CoreSidebar[/zhCN core/]
CoreSidebar --> CoreOverview[概览]
CoreSidebar --> CoreArchitecture[架构组件]
CoreSidebar --> CoreContext[Context 上下文]
CoreSidebar --> CoreAsyncInit[异步初始化]
CoreSidebar --> CoreLifecycle[生命周期]
CoreSidebar --> CoreCommand[命令系统]
CoreSidebar --> CoreQuery[查询系统]
CoreSidebar --> CoreCQRS[CQRS 模式]
CoreSidebar --> CoreEvents[事件系统]
CoreSidebar --> CoreProperty[属性系统]
CoreSidebar --> CoreIoC[IoC 容器]
CoreSidebar --> CoreECS[ECS 系统集成]
CoreSidebar --> CoreCoroutine[协程系统]
CoreSidebar --> CoreStateMachine[状态机]
CoreSidebar --> CorePause[暂停系统]
CoreSidebar --> CorePool[对象池]
CoreSidebar --> CoreResource[资源管理]
CoreSidebar --> CoreConfiguration[配置管理]
CoreSidebar --> CoreLogging[日志系统]
CoreSidebar --> CoreFunctional[函数式编程]
CoreSidebar --> CoreExtensions[扩展方法]
%% Game sidebar
Sidebars --> GameSidebar[/zhCN game/]
GameSidebar --> GameOverview[概览]
GameSidebar --> GameData[数据管理]
GameSidebar --> GameScene[场景系统]
GameSidebar --> GameUI[UI 系统]
GameSidebar --> GameStorage[存储系统]
GameSidebar --> GameSerialization[序列化]
GameSidebar --> GameSetting[游戏设置]
%% Godot sidebar
Sidebars --> GodotSidebar[/zhCN godot/]
GodotSidebar --> GodotOverview[概览]
GodotSidebar --> GodotExtensions[节点扩展]
GodotSidebar --> GodotSignal[信号系统]
GodotSidebar --> GodotStorage[存储系统]
GodotSidebar --> GodotPause[暂停系统]
GodotSidebar --> GodotPool[对象池]
GodotSidebar --> GodotLogging[日志系统]
GodotSidebar --> GodotSetting[设置系统]
%% Source generators sidebar
Sidebars --> GeneratorsSidebar[/zhCN sourcegenerators/]
GeneratorsSidebar --> GenOverview[概览]
GeneratorsSidebar --> GenLogging[日志生成器]
GeneratorsSidebar --> GenEnum[枚举扩展]
GeneratorsSidebar --> GenContextAware[ContextAware 生成器]
%% Tutorials sidebar
Sidebars --> TutorialsSidebar[/zhCN tutorials/]
TutorialsSidebar --> TutOverview[概览]
TutorialsSidebar --> TutQuickStart[快速开始]
TutorialsSidebar --> TutCoroutine[使用协程系统]
TutorialsSidebar --> TutStateMachine[实现状态机]
TutorialsSidebar --> TutPausePractice[暂停系统实践]
TutorialsSidebar --> TutFunctional[函数式编程实践]
TutorialsSidebar --> TutResource[资源管理最佳实践]
TutorialsSidebar --> TutSaveSystem[实现存档系统]
TutorialsSidebar --> TutDataMigration[数据迁移]
TutorialsSidebar --> TutGodotIntegration[Godot 集成]
TutorialsSidebar --> TutGodotProject[Godot 完整项目]
TutorialsSidebar --> TutAdvancedPatterns[高级模式]
TutorialsSidebar --> TutLargeProject[大型项目组织]
TutorialsSidebar --> TutUnitTesting[单元测试]
%% Best practices sidebar
Sidebars --> BestPracticesSidebar[/zhCN bestpractices/]
BestPracticesSidebar --> BPOverview[概览]
BestPracticesSidebar --> BPArchitecturePatterns[架构模式]
BestPracticesSidebar --> BPErrorHandling[错误处理]
BestPracticesSidebar --> BPPerformance[性能优化]
BestPracticesSidebar --> BPMobileOptimization[移动端优化]
BestPracticesSidebar --> BPMultiplayer[多人游戏]
%% API reference sidebar
Sidebars --> APISidebar[/zhCN apireference/]
APISidebar --> APIOverview[API 文档]
文件级变更
提示与命令与 Sourcery 交互
自定义你的体验访问你的 控制面板 来：
获取帮助Original review guide in EnglishReviewer's GuideUpdate the Chinese documentation navigation in VitePress to introduce a new “Best Practices” section, expand sidebars for core, game, Godot, and tutorials, and add new top-level and grouped menu items including API reference and other support docs, while renaming the rule source generator entry to a ContextAware generator. Flow diagram for updated zh-CN documentation navigation structureflowchart TD
Root[zhCN documentation navigation]
Root --> TopNav[Top navigation]
Root --> Sidebars[Sidebars by section]
%% Top navigation items
TopNav --> NavCore[Core 核心]
TopNav --> NavGame[Game 游戏]
TopNav --> NavGodot[Godot]
TopNav --> NavSourceGenerators[源码生成器]
TopNav --> NavTutorials[教程]
TopNav --> NavBestPractices[最佳实践]
TopNav --> NavMore[更多 下拉菜单]
NavMore --> MoreAPIReference[API 参考]
NavMore --> MoreFAQ[常见问题]
NavMore --> MoreTroubleshooting[故障排查]
NavMore --> MoreMigrationGuide[迁移指南]
NavMore --> MoreContributing[贡献指南]
%% Core sidebar
Sidebars --> CoreSidebar[/zhCN core/]
CoreSidebar --> CoreOverview[概览]
CoreSidebar --> CoreArchitecture[架构组件]
CoreSidebar --> CoreContext[Context 上下文]
CoreSidebar --> CoreAsyncInit[异步初始化]
CoreSidebar --> CoreLifecycle[生命周期]
CoreSidebar --> CoreCommand[命令系统]
CoreSidebar --> CoreQuery[查询系统]
CoreSidebar --> CoreCQRS[CQRS 模式]
CoreSidebar --> CoreEvents[事件系统]
CoreSidebar --> CoreProperty[属性系统]
CoreSidebar --> CoreIoC[IoC 容器]
CoreSidebar --> CoreECS[ECS 系统集成]
CoreSidebar --> CoreCoroutine[协程系统]
CoreSidebar --> CoreStateMachine[状态机]
CoreSidebar --> CorePause[暂停系统]
CoreSidebar --> CorePool[对象池]
CoreSidebar --> CoreResource[资源管理]
CoreSidebar --> CoreConfiguration[配置管理]
CoreSidebar --> CoreLogging[日志系统]
CoreSidebar --> CoreFunctional[函数式编程]
CoreSidebar --> CoreExtensions[扩展方法]
%% Game sidebar
Sidebars --> GameSidebar[/zhCN game/]
GameSidebar --> GameOverview[概览]
GameSidebar --> GameData[数据管理]
GameSidebar --> GameScene[场景系统]
GameSidebar --> GameUI[UI 系统]
GameSidebar --> GameStorage[存储系统]
GameSidebar --> GameSerialization[序列化]
GameSidebar --> GameSetting[游戏设置]
%% Godot sidebar
Sidebars --> GodotSidebar[/zhCN godot/]
GodotSidebar --> GodotOverview[概览]
GodotSidebar --> GodotExtensions[节点扩展]
GodotSidebar --> GodotSignal[信号系统]
GodotSidebar --> GodotStorage[存储系统]
GodotSidebar --> GodotPause[暂停系统]
GodotSidebar --> GodotPool[对象池]
GodotSidebar --> GodotLogging[日志系统]
GodotSidebar --> GodotSetting[设置系统]
%% Source generators sidebar
Sidebars --> GeneratorsSidebar[/zhCN sourcegenerators/]
GeneratorsSidebar --> GenOverview[概览]
GeneratorsSidebar --> GenLogging[日志生成器]
GeneratorsSidebar --> GenEnum[枚举扩展]
GeneratorsSidebar --> GenContextAware[ContextAware 生成器]
%% Tutorials sidebar
Sidebars --> TutorialsSidebar[/zhCN tutorials/]
TutorialsSidebar --> TutOverview[概览]
TutorialsSidebar --> TutQuickStart[快速开始]
TutorialsSidebar --> TutCoroutine[使用协程系统]
TutorialsSidebar --> TutStateMachine[实现状态机]
TutorialsSidebar --> TutPausePractice[暂停系统实践]
TutorialsSidebar --> TutFunctional[函数式编程实践]
TutorialsSidebar --> TutResource[资源管理最佳实践]
TutorialsSidebar --> TutSaveSystem[实现存档系统]
TutorialsSidebar --> TutDataMigration[数据迁移]
TutorialsSidebar --> TutGodotIntegration[Godot 集成]
TutorialsSidebar --> TutGodotProject[Godot 完整项目]
TutorialsSidebar --> TutAdvancedPatterns[高级模式]
TutorialsSidebar --> TutLargeProject[大型项目组织]
TutorialsSidebar --> TutUnitTesting[单元测试]
%% Best practices sidebar
Sidebars --> BestPracticesSidebar[/zhCN bestpractices/]
BestPracticesSidebar --> BPOverview[概览]
BestPracticesSidebar --> BPArchitecturePatterns[架构模式]
BestPracticesSidebar --> BPErrorHandling[错误处理]
BestPracticesSidebar --> BPPerformance[性能优化]
BestPracticesSidebar --> BPMobileOptimization[移动端优化]
BestPracticesSidebar --> BPMultiplayer[多人游戏]
%% API reference sidebar
Sidebars --> APISidebar[/zhCN apireference/]
APISidebar --> APIOverview[API 文档]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| C# |  |
Mar 7, 2026 3:34p.m. | Review ↗ |
| Secrets | |
Mar 7, 2026 3:34p.m. | Review ↗ |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
你好，我在这里给出一些总体反馈：
nav和sidebar下新增的链接同时使用了带和不带末尾斜杠的 URL（例如/zh-CN/faq和/zh-CN/api-reference/）；建议统一采用一种风格，以避免产生细微的路由或 SEO 不一致问题。/zh-CN/api-reference/侧边栏目前只有一个条目，并且链接回同一个索引页；你可以考虑简化这一部分，或者规划更多子页面，让侧边栏结构带来更明确的价值。
给 AI Agent 的提示词
Please address the comments from this code review:
## Overall Comments
- The new links under `nav` and `sidebar` mix URLs with and without trailing slashes (e.g. `/zh-CN/faq` vs `/zh-CN/api-reference/`); consider standardizing on one style to avoid subtle routing or SEO inconsistencies.
- The `/zh-CN/api-reference/` sidebar currently contains a single item linking back to the same index page; you might simplify this section or plan additional child pages so the sidebar structure adds clear value.帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进之后的代码评审。
Original comment in English
Hey - I've left some high level feedback:
- The new links under
navandsidebarmix URLs with and without trailing slashes (e.g./zh-CN/faqvs/zh-CN/api-reference/); consider standardizing on one style to avoid subtle routing or SEO inconsistencies. - The
/zh-CN/api-reference/sidebar currently contains a single item linking back to the same index page; you might simplify this section or plan additional child pages so the sidebar structure adds clear value.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new links under `nav` and `sidebar` mix URLs with and without trailing slashes (e.g. `/zh-CN/faq` vs `/zh-CN/api-reference/`); consider standardizing on one style to avoid subtle routing or SEO inconsistencies.
- The `/zh-CN/api-reference/` sidebar currently contains a single item linking back to the same index page; you might simplify this section or plan additional child pages so the sidebar structure adds clear value.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
- 修正了 API 参考链接路径，移除了末尾多余的斜杠 - 移除了重复的 API 参考侧边栏配置项 - 确保导航链接的一致性和正确性
This was referenced Mar 15, 2026
This was referenced May 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
重构中文版文档的导航结构，引入新的章节，并为 core、game、Godot 和教程等内容分组归类。
Documentation:
Original summary in English
Summary by Sourcery
Restructure the Chinese documentation navigation to introduce new sections and group related content for core, game, Godot, and tutorials.
Documentation: