mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-06 16:16:44 +08:00
docs(readme): 对齐文档入口标签与落地页元数据
- 更新模块 README、仓库根 README 与中文落地页的 reader-facing 文档入口标签 - 补充 docs 语言落地页 metadata 并校正文档治理 topic 的恢复点与阈值指标
This commit is contained in:
gewuyou
parent
64385196d5
commit
77540c07f0
@ -49,7 +49,7 @@ XML 注释。这里记录的是类型族级基线，成员级契约细节仍需
|
||||
| `Configuration/` `Environment/` `Data/` `Serializer/` `Storage/` `Versioning/` | `7/7` 个类型声明已带 XML 注释 | `IConfigurationManager`、`IEnvironment`、`ILoadableFrom<T>`、`ISerializer`、`IStorage` |
|
||||
| `Bases/` `Controller/` `Model/` `Systems/` `Utility/` `Rule/` `Enums/` `Properties/` | `19/19` 个类型声明已带 XML 注释 | `IPrioritized`、`IController`、`IModel`、`ISystem`、`IContextUtility`、`ArchitecturePhase` |
|
||||
|
||||
完整 inventory 与阅读顺序见 `docs/zh-CN/abstractions/core-abstractions.md`。
|
||||
完整 inventory 与阅读顺序见 [Core 抽象层说明](../docs/zh-CN/abstractions/core-abstractions.md)。
|
||||
|
||||
## 采用建议
|
||||
|
||||
|
||||
@ -75,7 +75,7 @@ XML 注释。这里先保留阅读基线，成员级 ``<param>`` / ``<returns>``
|
||||
| `Logging/` `Localization/` `Configuration/` `Environment/` `Ioc/` | `31/31` 个类型声明已带 XML 注释 | `ConsoleLogger`、`LocalizationManager`、`ConfigurationManager`、`DefaultEnvironment`、`MicrosoftDiContainer` |
|
||||
| `Model/` `Systems/` `Utility/` `Rule/` `Extensions/` `Functional/` | `34/34` 个类型声明已带 XML 注释 | `AbstractModel`、`AbstractSystem`、`NumericDisplayFormatter`、`ContextAwareBase`、`Result<T>` |
|
||||
|
||||
完整的模块化阅读顺序和 inventory 说明见 `docs/zh-CN/core/index.md`。
|
||||
完整的模块化阅读顺序和 inventory 说明见 [Core 栏目](../docs/zh-CN/core/index.md)。
|
||||
|
||||
## 最小接入路径
|
||||
|
||||
|
||||
@ -97,5 +97,5 @@ public sealed class GetPlayerProfileHandler
|
||||
|
||||
## 文档入口
|
||||
|
||||
- 运行时与整体接入说明：`docs/zh-CN/core/cqrs.md`
|
||||
- 如果你需要默认实现而不是契约层，请看 `GFramework.Cqrs/README.md`
|
||||
- 运行时与整体接入说明：[CQRS 栏目](../docs/zh-CN/core/cqrs.md)
|
||||
- 如果你需要默认实现而不是契约层，请看 [GFramework.Cqrs README](../GFramework.Cqrs/README.md)
|
||||
|
||||
@ -150,5 +150,5 @@ var playerId = await this.SendAsync(new CreatePlayerCommand(new CreatePlayerInpu
|
||||
|
||||
## 文档入口
|
||||
|
||||
- 总体文档：`docs/zh-CN/core/cqrs.md`
|
||||
- 契约层说明：`GFramework.Cqrs.Abstractions/README.md`
|
||||
- 总体文档：[CQRS 栏目](../docs/zh-CN/core/cqrs.md)
|
||||
- 契约层说明：[GFramework.Cqrs.Abstractions README](../GFramework.Cqrs.Abstractions/README.md)
|
||||
|
||||
@ -236,14 +236,14 @@ public sealed class ContinueGameCommandHandler
|
||||
|
||||
虽然大部分详细文档写在 `GFramework.Game` 侧，但阅读顺序仍然适用于本包：
|
||||
|
||||
- 游戏模块总览：[docs/zh-CN/game/index.md](../docs/zh-CN/game/index.md)
|
||||
- 内容配置系统：[docs/zh-CN/game/config-system.md](../docs/zh-CN/game/config-system.md)
|
||||
- 数据与存档：[docs/zh-CN/game/data.md](../docs/zh-CN/game/data.md)
|
||||
- 设置系统：[docs/zh-CN/game/setting.md](../docs/zh-CN/game/setting.md)
|
||||
- 存储系统：[docs/zh-CN/game/storage.md](../docs/zh-CN/game/storage.md)
|
||||
- 序列化系统：[docs/zh-CN/game/serialization.md](../docs/zh-CN/game/serialization.md)
|
||||
- 场景系统：[docs/zh-CN/game/scene.md](../docs/zh-CN/game/scene.md)
|
||||
- UI 系统：[docs/zh-CN/game/ui.md](../docs/zh-CN/game/ui.md)
|
||||
- 游戏模块总览：[Game 模块总览](../docs/zh-CN/game/index.md)
|
||||
- 内容配置系统：[内容配置系统](../docs/zh-CN/game/config-system.md)
|
||||
- 数据与存档：[数据与存档系统](../docs/zh-CN/game/data.md)
|
||||
- 设置系统：[设置系统](../docs/zh-CN/game/setting.md)
|
||||
- 存储系统：[存储系统](../docs/zh-CN/game/storage.md)
|
||||
- 序列化系统：[序列化系统](../docs/zh-CN/game/serialization.md)
|
||||
- 场景系统：[场景系统](../docs/zh-CN/game/scene.md)
|
||||
- UI 系统：[UI 系统](../docs/zh-CN/game/ui.md)
|
||||
|
||||
## 选择建议
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@
|
||||
|
||||
对应文档：
|
||||
|
||||
- [docs/zh-CN/game/config-system.md](../docs/zh-CN/game/config-system.md)
|
||||
- [docs/zh-CN/game/index.md](../docs/zh-CN/game/index.md)
|
||||
- [内容配置系统](../docs/zh-CN/game/config-system.md)
|
||||
- [Game 模块总览](../docs/zh-CN/game/index.md)
|
||||
|
||||
### `Data/`
|
||||
|
||||
@ -81,8 +81,8 @@
|
||||
|
||||
对应文档：
|
||||
|
||||
- [docs/zh-CN/game/data.md](../docs/zh-CN/game/data.md)
|
||||
- [docs/zh-CN/game/setting.md](../docs/zh-CN/game/setting.md)
|
||||
- [数据与存档系统](../docs/zh-CN/game/data.md)
|
||||
- [设置系统](../docs/zh-CN/game/setting.md)
|
||||
|
||||
### `Setting/`
|
||||
|
||||
@ -105,7 +105,7 @@
|
||||
|
||||
对应文档：
|
||||
|
||||
- [docs/zh-CN/game/setting.md](../docs/zh-CN/game/setting.md)
|
||||
- [设置系统](../docs/zh-CN/game/setting.md)
|
||||
|
||||
### `Storage/`
|
||||
|
||||
@ -121,7 +121,7 @@
|
||||
|
||||
对应文档：
|
||||
|
||||
- [docs/zh-CN/game/storage.md](../docs/zh-CN/game/storage.md)
|
||||
- [存储系统](../docs/zh-CN/game/storage.md)
|
||||
- [GFramework.Game/Storage/ReadMe.md](./Storage/ReadMe.md)
|
||||
|
||||
### `Serializer/`
|
||||
@ -134,7 +134,7 @@
|
||||
|
||||
对应文档：
|
||||
|
||||
- [docs/zh-CN/game/serialization.md](../docs/zh-CN/game/serialization.md)
|
||||
- [序列化系统](../docs/zh-CN/game/serialization.md)
|
||||
|
||||
### `Scene/` 与 `UI/`
|
||||
|
||||
@ -157,8 +157,8 @@
|
||||
|
||||
对应文档：
|
||||
|
||||
- [docs/zh-CN/game/scene.md](../docs/zh-CN/game/scene.md)
|
||||
- [docs/zh-CN/game/ui.md](../docs/zh-CN/game/ui.md)
|
||||
- [场景系统](../docs/zh-CN/game/scene.md)
|
||||
- [UI 系统](../docs/zh-CN/game/ui.md)
|
||||
|
||||
### `Routing/` 与 `State/`
|
||||
|
||||
@ -293,7 +293,7 @@ var registry = bootstrap.Registry;
|
||||
|
||||
这一能力几乎总是与 source generators 绑定使用。目录、schema、生成器与热重载约定请直接看：
|
||||
|
||||
- [docs/zh-CN/game/config-system.md](../docs/zh-CN/game/config-system.md)
|
||||
- [内容配置系统](../docs/zh-CN/game/config-system.md)
|
||||
|
||||
### 4. 接入 Scene / UI 路由
|
||||
|
||||
@ -342,14 +342,14 @@ public sealed class MyUiRouter : UiRouterBase
|
||||
|
||||
## 文档入口
|
||||
|
||||
- 游戏模块总览：[docs/zh-CN/game/index.md](../docs/zh-CN/game/index.md)
|
||||
- 内容配置系统：[docs/zh-CN/game/config-system.md](../docs/zh-CN/game/config-system.md)
|
||||
- 数据与存档：[docs/zh-CN/game/data.md](../docs/zh-CN/game/data.md)
|
||||
- 设置系统：[docs/zh-CN/game/setting.md](../docs/zh-CN/game/setting.md)
|
||||
- 存储系统：[docs/zh-CN/game/storage.md](../docs/zh-CN/game/storage.md)
|
||||
- 序列化系统：[docs/zh-CN/game/serialization.md](../docs/zh-CN/game/serialization.md)
|
||||
- 场景系统：[docs/zh-CN/game/scene.md](../docs/zh-CN/game/scene.md)
|
||||
- UI 系统：[docs/zh-CN/game/ui.md](../docs/zh-CN/game/ui.md)
|
||||
- 游戏模块总览：[Game 模块总览](../docs/zh-CN/game/index.md)
|
||||
- 内容配置系统：[内容配置系统](../docs/zh-CN/game/config-system.md)
|
||||
- 数据与存档：[数据与存档系统](../docs/zh-CN/game/data.md)
|
||||
- 设置系统：[设置系统](../docs/zh-CN/game/setting.md)
|
||||
- 存储系统：[存储系统](../docs/zh-CN/game/storage.md)
|
||||
- 序列化系统：[序列化系统](../docs/zh-CN/game/serialization.md)
|
||||
- 场景系统：[场景系统](../docs/zh-CN/game/scene.md)
|
||||
- UI 系统：[UI 系统](../docs/zh-CN/game/ui.md)
|
||||
|
||||
## 什么时候不该直接依赖本包
|
||||
|
||||
|
||||
@ -183,15 +183,15 @@ public partial class MainMenu : Control
|
||||
|
||||
## 文档入口
|
||||
|
||||
- 生成器总览：[docs/zh-CN/source-generators/index.md](../docs/zh-CN/source-generators/index.md)
|
||||
- Godot 项目元数据：[docs/zh-CN/source-generators/godot-project-generator.md](../docs/zh-CN/source-generators/godot-project-generator.md)
|
||||
- `GetNode`：[docs/zh-CN/source-generators/get-node-generator.md](../docs/zh-CN/source-generators/get-node-generator.md)
|
||||
- `BindNodeSignal`：[docs/zh-CN/source-generators/bind-node-signal-generator.md](../docs/zh-CN/source-generators/bind-node-signal-generator.md)
|
||||
- `AutoScene`：[docs/zh-CN/source-generators/auto-scene-generator.md](../docs/zh-CN/source-generators/auto-scene-generator.md)
|
||||
- `AutoUiPage`：[docs/zh-CN/source-generators/auto-ui-page-generator.md](../docs/zh-CN/source-generators/auto-ui-page-generator.md)
|
||||
- `AutoRegisterExportedCollections`：[docs/zh-CN/source-generators/auto-register-exported-collections-generator.md](../docs/zh-CN/source-generators/auto-register-exported-collections-generator.md)
|
||||
- 生成器总览：[源码生成器总览](../docs/zh-CN/source-generators/index.md)
|
||||
- Godot 项目元数据：[Godot 项目生成器](../docs/zh-CN/source-generators/godot-project-generator.md)
|
||||
- `GetNode`：[GetNode 生成器](../docs/zh-CN/source-generators/get-node-generator.md)
|
||||
- `BindNodeSignal`：[BindNodeSignal 生成器](../docs/zh-CN/source-generators/bind-node-signal-generator.md)
|
||||
- `AutoScene`：[AutoScene 生成器](../docs/zh-CN/source-generators/auto-scene-generator.md)
|
||||
- `AutoUiPage`：[AutoUiPage 生成器](../docs/zh-CN/source-generators/auto-ui-page-generator.md)
|
||||
- `AutoRegisterExportedCollections`：[AutoRegisterExportedCollections 生成器](../docs/zh-CN/source-generators/auto-register-exported-collections-generator.md)
|
||||
- Godot 运行时入口：[../GFramework.Godot/README.md](../GFramework.Godot/README.md)
|
||||
- 集成教程：[docs/zh-CN/tutorials/godot-integration.md](../docs/zh-CN/tutorials/godot-integration.md)
|
||||
- 集成教程：[Godot 集成教程](../docs/zh-CN/tutorials/godot-integration.md)
|
||||
|
||||
## 什么时候不该先看这个包
|
||||
|
||||
@ -202,4 +202,4 @@ public partial class MainMenu : Control
|
||||
- 你只需要 `Game` 契约，不需要 Godot 宿主或生成器：
|
||||
- 先看 `GFramework.Game` 或 `GFramework.Game.Abstractions`
|
||||
- 你在确认项目接线顺序，而不是单个生成器契约：
|
||||
- 先看 `docs/zh-CN/tutorials/godot-integration.md`
|
||||
- 先看 [Godot 集成教程](../docs/zh-CN/tutorials/godot-integration.md)
|
||||
|
||||
@ -139,14 +139,14 @@ Godot 上。
|
||||
|
||||
## 文档入口
|
||||
|
||||
- Godot 运行时总览：[docs/zh-CN/godot/index.md](../docs/zh-CN/godot/index.md)
|
||||
- 架构集成：[docs/zh-CN/godot/architecture.md](../docs/zh-CN/godot/architecture.md)
|
||||
- 场景系统：[docs/zh-CN/godot/scene.md](../docs/zh-CN/godot/scene.md)
|
||||
- UI 系统：[docs/zh-CN/godot/ui.md](../docs/zh-CN/godot/ui.md)
|
||||
- 节点扩展：[docs/zh-CN/godot/extensions.md](../docs/zh-CN/godot/extensions.md)
|
||||
- 信号系统：[docs/zh-CN/godot/signal.md](../docs/zh-CN/godot/signal.md)
|
||||
- 日志系统：[docs/zh-CN/godot/logging.md](../docs/zh-CN/godot/logging.md)
|
||||
- 集成教程：[docs/zh-CN/tutorials/godot-integration.md](../docs/zh-CN/tutorials/godot-integration.md)
|
||||
- Godot 运行时总览：[Godot 模块总览](../docs/zh-CN/godot/index.md)
|
||||
- 架构集成：[Godot 架构集成](../docs/zh-CN/godot/architecture.md)
|
||||
- 场景系统：[Godot 场景系统](../docs/zh-CN/godot/scene.md)
|
||||
- UI 系统：[Godot UI 系统](../docs/zh-CN/godot/ui.md)
|
||||
- 节点扩展：[Godot 节点扩展](../docs/zh-CN/godot/extensions.md)
|
||||
- 信号系统：[Godot 信号系统](../docs/zh-CN/godot/signal.md)
|
||||
- 日志系统：[Godot 日志系统](../docs/zh-CN/godot/logging.md)
|
||||
- 集成教程：[Godot 集成教程](../docs/zh-CN/tutorials/godot-integration.md)
|
||||
- 生成器入口：[../GFramework.Godot.SourceGenerators/README.md](../GFramework.Godot.SourceGenerators/README.md)
|
||||
|
||||
## 什么时候不该把它当成主入口
|
||||
|
||||
34
README.md
34
README.md
@ -11,8 +11,8 @@
|
||||
|
||||
## 从哪里开始
|
||||
|
||||
- 第一次接触框架：[`docs/zh-CN/getting-started/index.md`](docs/zh-CN/getting-started/index.md)
|
||||
- 想先跑一个最小例子：[`docs/zh-CN/getting-started/quick-start.md`](docs/zh-CN/getting-started/quick-start.md)
|
||||
- 第一次接触框架：[入门指南](docs/zh-CN/getting-started/index.md)
|
||||
- 想先跑一个最小例子：[快速开始](docs/zh-CN/getting-started/quick-start.md)
|
||||
- 已经知道要用哪个模块：直接进入对应模块目录下的 `README.md`
|
||||
|
||||
## 模块地图
|
||||
@ -41,25 +41,25 @@
|
||||
| --- | --- | --- |
|
||||
| `GFramework.Core.SourceGenerators.Abstractions` | `Core.SourceGenerators` 的内部契约层 | [GFramework.Core.SourceGenerators/README.md](GFramework.Core.SourceGenerators/README.md) |
|
||||
| `GFramework.Godot.SourceGenerators.Abstractions` | `Godot.SourceGenerators` 的内部契约层 | [GFramework.Godot.SourceGenerators/README.md](GFramework.Godot.SourceGenerators/README.md) |
|
||||
| `GFramework.SourceGenerators.Common` | 生成器家族共享的公共支撑代码 | [docs/zh-CN/source-generators/index.md](docs/zh-CN/source-generators/index.md) |
|
||||
| `GFramework.SourceGenerators.Common` | 生成器家族共享的公共支撑代码 | [源码生成器总览](docs/zh-CN/source-generators/index.md) |
|
||||
|
||||
## 文档导航
|
||||
|
||||
仓库根 README 与文档站点保持同一套栏目命名：
|
||||
|
||||
- 入门指南：[`docs/zh-CN/getting-started/index.md`](docs/zh-CN/getting-started/index.md)
|
||||
- Core：[`docs/zh-CN/core/index.md`](docs/zh-CN/core/index.md)
|
||||
- Game：[`docs/zh-CN/game/index.md`](docs/zh-CN/game/index.md)
|
||||
- Godot：[`docs/zh-CN/godot/index.md`](docs/zh-CN/godot/index.md)
|
||||
- 教程：[`docs/zh-CN/tutorials/index.md`](docs/zh-CN/tutorials/index.md)
|
||||
- 源码生成器：[`docs/zh-CN/source-generators/index.md`](docs/zh-CN/source-generators/index.md)
|
||||
- ECS：[`docs/zh-CN/ecs/index.md`](docs/zh-CN/ecs/index.md)
|
||||
- 抽象接口：[`docs/zh-CN/abstractions/index.md`](docs/zh-CN/abstractions/index.md)
|
||||
- 最佳实践：[`docs/zh-CN/best-practices/index.md`](docs/zh-CN/best-practices/index.md)
|
||||
- API 参考：[`docs/zh-CN/api-reference/index.md`](docs/zh-CN/api-reference/index.md)
|
||||
- FAQ：[`docs/zh-CN/faq.md`](docs/zh-CN/faq.md)
|
||||
- 故障排查：[`docs/zh-CN/troubleshooting.md`](docs/zh-CN/troubleshooting.md)
|
||||
- 贡献：[`docs/zh-CN/contributing.md`](docs/zh-CN/contributing.md)
|
||||
- 入门指南：[入门指南](docs/zh-CN/getting-started/index.md)
|
||||
- Core：[Core](docs/zh-CN/core/index.md)
|
||||
- Game：[Game](docs/zh-CN/game/index.md)
|
||||
- Godot：[Godot](docs/zh-CN/godot/index.md)
|
||||
- 教程：[教程](docs/zh-CN/tutorials/index.md)
|
||||
- 源码生成器：[源码生成器](docs/zh-CN/source-generators/index.md)
|
||||
- ECS：[ECS](docs/zh-CN/ecs/index.md)
|
||||
- 抽象接口：[抽象接口](docs/zh-CN/abstractions/index.md)
|
||||
- 最佳实践：[最佳实践](docs/zh-CN/best-practices/index.md)
|
||||
- API 参考：[API 参考](docs/zh-CN/api-reference/index.md)
|
||||
- FAQ：[常见问题](docs/zh-CN/faq.md)
|
||||
- 故障排查：[故障排查](docs/zh-CN/troubleshooting.md)
|
||||
- 贡献：[贡献指南](docs/zh-CN/contributing.md)
|
||||
|
||||
## 包选择
|
||||
|
||||
@ -146,7 +146,7 @@ GFramework.sln
|
||||
提交功能或行为变更时，请把代码、测试和文档一起更新：
|
||||
|
||||
1. 先阅读对应模块目录下的 `README.md`
|
||||
2. 如果改动影响采用路径、安装方式、公共 API 或目录结构，同时更新 `docs/zh-CN/`
|
||||
2. 如果改动影响采用路径、安装方式、公共 API 或目录结构，同时更新 [中文文档入口](docs/zh-CN/index.md)
|
||||
3. 对跨模块或多阶段任务，维护 `ai-plan/public/README.md` 与对应主题目录下的 tracking / trace
|
||||
|
||||
## 许可证
|
||||
|
||||
@ -12,12 +12,12 @@
|
||||
|
||||
## 当前恢复点
|
||||
|
||||
- 恢复点编号：`DOCUMENTATION-FULL-COVERAGE-GOV-RP-028`
|
||||
- 恢复点编号：`DOCUMENTATION-FULL-COVERAGE-GOV-RP-029`
|
||||
- 当前阶段：`Phase 5 - Governance Maintenance`
|
||||
- 当前焦点：
|
||||
- 继续按 `$gframework-batch-boot 75` 的 `origin/main` 分支 diff 阈值做小批量文档治理，本批已收口 `25` 个 `docs/zh-CN` 页面中的站内链接 `.md` / `index.md` 一致性
|
||||
- 继续按 `$gframework-batch-boot 75` 的 `origin/main` 分支 diff 阈值做小批量文档治理，本批已收口模块 `README.md`、`docs/index.md` 与多组中文落地页之间的读者入口对齐
|
||||
- 保持 `README.md` 与 `docs/**` 公开页面只承载读者需要的采用信息，不再混入 XML inventory、覆盖基线、恢复点或治理批次说明
|
||||
- 继续优先处理低风险 metadata 缺口、坏链、README 文档入口对齐与 Markdown 结构问题，避免跨模块语义改写
|
||||
- 继续优先处理低风险 metadata 缺口、坏链、README 文档入口对齐、Reader-friendly 链接标签与 Markdown 结构问题，避免跨模块语义改写
|
||||
- 保持 `Game` persistence docs surface 与当前 `README`、源码、`PersistenceTests` 使用同一套 owner / adoption path 叙述
|
||||
- 保持 `GFramework.Godot.SourceGenerators/README.md` 与 `docs/zh-CN/tutorials/godot-integration.md` 在生命周期接法上的一致性
|
||||
- 保持 active tracking / trace 只承载当前恢复入口，把阶段细节留在 `archive/`
|
||||
@ -25,7 +25,7 @@
|
||||
## 当前状态摘要
|
||||
|
||||
- `Core`、`Ecs.Arch`、`Cqrs`、`Game`、`Godot` 五个模块族当前都已有 README / landing / topic / API 参考层级的已验证入口。
|
||||
- `2026-04-24` 以 `origin/main`（`a8447a6`，`2026-04-24T12:53:39+08:00`）为 batch baseline 时，当前分支累计 diff 在 `RP-027` 提交后为 `10` 个文件；本批 write set 额外覆盖 `25` 个 `docs/zh-CN` 页面与 `2` 个 `ai-plan` 入口文件，提交后分支 diff 为 `29 / 75` 个 changed files。
|
||||
- `2026-04-24` 以 `origin/main`（`a8447a6`，`2026-04-24T12:53:39+08:00`）为 batch baseline 时，当前分支累计 diff 在 `RP-028` 提交后为 `29` 个文件；本批 write set 额外覆盖 `31` 个文件（`29` 个 README / docs 页面 + `2` 个 `ai-plan` 入口），提交后分支 diff 为 `58 / 75` 个 changed files。
|
||||
- `2026-04-24` 使用 `$gframework-pr-review` 抓取 PR `#282` 后，确认 latest head commit
|
||||
`982249151ecf8acdff3e62e664034bf95dfacd75` 当前仍有 `3` 条 CodeRabbit 与 `1` 条 Greptile open thread；4 条建议均已在本地复核并纳入当前恢复点。
|
||||
- 本轮 PR follow-up 仅收口仍然成立的 review 项：
|
||||
@ -34,6 +34,7 @@
|
||||
- 统一 `docs/zh-CN/troubleshooting.md` 中 `/zh-CN/core/architecture` 与 `/zh-CN/faq` 的 `.md` 链接写法
|
||||
- 本批次补齐了 `docs/zh-CN/index.md` 的 `description`，以及 `docs/zh-CN/tutorials/basic/01-07.md` 的 `title` / `description`，让首页和基础教程章节页拥有完整 frontmatter metadata。
|
||||
- 本批次统一将教程、最佳实践、Core、Godot 页面里缺显式扩展名的站内 Markdown 链接补齐为 `.md` 或 `index.md`，避免目录链接、绝对路径旧写法与 VitePress 构建解析分叉。
|
||||
- 本批次把模块 README、仓库根 README、`docs/index.md` 及多组中文落地页里直接暴露文件路径的入口调整为读者友好的可点击标签，同时补齐语言落地页 metadata 与 README 指向。
|
||||
- `Game` persistence docs surface 当前以 `docs/zh-CN/game/data.md`、`storage.md`、`serialization.md`、`setting.md`
|
||||
作为最小巡检集合；若后续 README、runtime public API 或 `PersistenceTests` 变动，应优先复核这一组页面。
|
||||
- `Godot` runtime 与 generator 入口当前以 `GFramework.Godot/README.md`、
|
||||
@ -79,10 +80,12 @@
|
||||
- 结果：通过；当前 `docs/zh-CN` 站内 Markdown 链接已无缺失扩展名的命中。
|
||||
- `2026-04-24` `bun run build`（工作目录：`docs/`）
|
||||
- 结果：通过；`25` 个页面的站内链接补齐为显式 `.md` / `index.md` 后站点仍可正常构建，仅保留既有大 chunk warning。
|
||||
- `2026-04-24` `bun run build`（工作目录：`docs/`）
|
||||
- 结果：通过；模块 README、中文落地页 reader-facing 文档入口对齐，以及 `docs/index.md` metadata 调整后站点仍可正常构建，仅保留既有大 chunk warning。
|
||||
|
||||
## 下一步
|
||||
|
||||
1. 若继续执行 `$gframework-batch-boot 75`，优先盘点模块 `README.md`、`docs/index.md` 与文档落地页之间仍未对齐的文档入口、BOM 与旧链接写法。
|
||||
1. 当前分支达到 `58 / 75` 个 changed files 后，若继续执行 `$gframework-batch-boot 75`，应优先选择 `5` 到 `10` 个文件以内的小批次，避免显著降低 reviewability。
|
||||
2. 推送当前批次 commit 后，再次执行 `$gframework-pr-review`，确认 PR `#282` 的 unresolved review threads 是否已在新 head commit 上消失。
|
||||
3. 若后续分支继续调整 `Game` persistence runtime、README 或公共 API，优先复核 `docs/zh-CN/game/data.md`、
|
||||
`storage.md`、`serialization.md`、`setting.md` 与 landing page 是否仍保持同一套职责边界。
|
||||
|
||||
@ -2,28 +2,25 @@
|
||||
|
||||
## 2026-04-24
|
||||
|
||||
### 当前恢复点：RP-028
|
||||
### 当前恢复点：RP-029
|
||||
|
||||
- 以 `origin/main`（`a8447a6`，`2026-04-24T12:53:39+08:00`）为 `$gframework-batch-boot 75` baseline，确认 `RP-027` 提交后的当前分支累计 diff 为 `10` 个文件。
|
||||
- 选择“站内 Markdown 链接显式扩展名统一”作为本批次低风险切片，集中处理教程、最佳实践、Core 与 Godot 页面中的目录链接和缺 `.md` 的旧写法。
|
||||
- 本批次修改了 `25` 个 `docs/zh-CN` 页面，把 `./`、`../`、`/zh-CN/` 开头的站内 Markdown 链接统一补齐为显式 `.md` 或 `index.md`。
|
||||
- 以 `origin/main`（`a8447a6`，`2026-04-24T12:53:39+08:00`）为 `$gframework-batch-boot 75` baseline，确认 `RP-028` 提交后的当前分支累计 diff 为 `29` 个文件。
|
||||
- 选择“README 与落地页 reader-facing 文档入口对齐”作为本批次低风险切片，集中处理模块 README、仓库根 README、`docs/index.md` 与多组中文落地页中的裸路径标签和 code span 文档入口。
|
||||
- 本批次修改了 `29` 个 README / docs 页面，并补充了 `2` 个 `ai-plan` 入口更新。
|
||||
|
||||
### 当前决策（RP-028）
|
||||
### 当前决策（RP-029）
|
||||
|
||||
- 当 branch diff 仍显著低于 `75` 文件阈值时，继续优先消化低风险链接规范化和 README / landing page 对齐问题，不在同一批次混入高语义重写。
|
||||
- 构建失败优先视为机械链接转换回归，先修复批量规则副作用再继续，而不是带着失效链接进入后续批次。
|
||||
- active `ai-plan` 入口继续保持轻量，只记录当前恢复点、batch metric、验证结果与下一批候选项。
|
||||
- 当 branch diff 接近 `58 / 75` 时，继续批量推进的前提应变成“每批只有很小的 write set 且收益明确”；否则优先停在当前恢复点，保留 reviewability。
|
||||
- README 与 landing page 的 reader-facing 入口应优先显示模块名、栏目名或功能名，而不是直接暴露仓库路径。
|
||||
- `docs/index.md` 作为语言落地页，即使主要依赖脚本跳转，也应保留明确的 `title` / `description` metadata，避免站点入口缺失基础说明。
|
||||
|
||||
### 当前验证（RP-028）
|
||||
### 当前验证（RP-029）
|
||||
|
||||
- 站内链接巡检：
|
||||
- `python3 - <<'PY' ...`（扫描 `docs/zh-CN/**/*.md` 中以 `./`、`../`、`/zh-CN/` 开头且未带扩展名的 Markdown 链接）
|
||||
- 结果：通过；当前 `docs/zh-CN` 站内 Markdown 链接已无缺失扩展名的命中。
|
||||
- 站点构建：
|
||||
- `bun run build`（工作目录：`docs/`）
|
||||
- 结果：通过；统一 `25` 个页面的站内链接后站点仍可正常构建，仅保留既有大 chunk warning。
|
||||
- 结果：通过；模块 README、中文落地页 reader-facing 文档入口对齐，以及 `docs/index.md` metadata 调整后站点仍可正常构建，仅保留既有大 chunk warning。
|
||||
- 当前 stop-condition metric：
|
||||
- 本批次 write set 为 `27` 个文件（`25` 个文档页面 + `2` 个 `ai-plan` 入口）；本批次提交后分支 diff 为 `29 / 75` 个 changed files。
|
||||
- 本批次 write set 为 `31` 个文件（`29` 个 README / docs 页面 + `2` 个 `ai-plan` 入口）；本批次提交后分支 diff 为 `58 / 75` 个 changed files。
|
||||
|
||||
### 归档指针
|
||||
|
||||
@ -35,5 +32,5 @@
|
||||
|
||||
### 下一步
|
||||
|
||||
1. 若继续执行 `$gframework-batch-boot 75`，优先盘点模块 `README.md`、`docs/index.md` 与文档落地页之间仍未对齐的文档入口、BOM 与旧链接写法。
|
||||
1. 若继续执行 `$gframework-batch-boot 75`，优先选择 `5` 到 `10` 个文件以内的小批次，例如剩余零散的 README 路径引用或单页 reader-facing 标签修正。
|
||||
2. 推送本批次 commit 后，再次执行 `$gframework-pr-review`，确认 PR `#282` 的 unresolved review threads 是否已在新 head commit 上消失。
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
---
|
||||
layout: page
|
||||
title: Language Selection
|
||||
description: Redirects visitors to the current Chinese documentation entry and keeps the language landing page discoverable.
|
||||
---
|
||||
|
||||
<script setup>
|
||||
|
||||
@ -98,6 +98,6 @@ public sealed class DiagnosticsFeature
|
||||
1. 先读本页，确认你是否真的只需要契约层
|
||||
2. 再看 [`../core/index.md`](../core/index.md) 了解默认运行时怎么组织这些契约
|
||||
3. 回到模块 README：
|
||||
- [`GFramework.Core.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.Abstractions/README.md)
|
||||
- [`GFramework.Core/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)
|
||||
- [`GFramework.Core.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.Abstractions/README.md)
|
||||
- [`GFramework.Core README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)
|
||||
4. 需要统一导航时，再看 [`../api-reference/index.md`](../api-reference/index.md)
|
||||
|
||||
@ -90,5 +90,5 @@ var options = new ArchOptions
|
||||
1. 先读本页，确认你是否真的只需要契约层
|
||||
2. 如果需要默认实现，再看 [`../ecs/arch.md`](../ecs/arch.md)
|
||||
3. 回到对应模块 README：
|
||||
- [`GFramework.Ecs.Arch.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch.Abstractions/README.md)
|
||||
- [`GFramework.Ecs.Arch/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch/README.md)
|
||||
- [`GFramework.Ecs.Arch.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch.Abstractions/README.md)
|
||||
- [`GFramework.Ecs.Arch README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch/README.md)
|
||||
|
||||
@ -117,5 +117,5 @@ public sealed class ContinueGameCommandHandler
|
||||
- [`../game/scene.md`](../game/scene.md)
|
||||
- [`../game/ui.md`](../game/ui.md)
|
||||
4. 需要仓库侧入口时，回到：
|
||||
- [`GFramework.Game.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
- [`GFramework.Game/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
- [`GFramework.Game.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
- [`GFramework.Game README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
|
||||
@ -29,11 +29,11 @@ description: GFramework 的 API 阅读入口，按模块映射 README、专题
|
||||
|
||||
| 模块族 | 模块 README | 站内入口 | XML 文档关注点 |
|
||||
| --- | --- | --- | --- |
|
||||
| `Core` / `Core.Abstractions` | [`GFramework.Core/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)、[`GFramework.Core.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.Abstractions/README.md) | [`../core/index.md`](../core/index.md)、[`../abstractions/core-abstractions.md`](../abstractions/core-abstractions.md) | 架构入口、生命周期、命令 / 查询 / 事件 / 状态 / 资源 / 日志 / 配置 / 并发契约 |
|
||||
| `Cqrs` / `Cqrs.Abstractions` / `Cqrs.SourceGenerators` | [`GFramework.Cqrs/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs/README.md)、[`GFramework.Cqrs.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs.Abstractions/README.md)、[`GFramework.Cqrs.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs.SourceGenerators/README.md) | [`../core/cqrs.md`](../core/cqrs.md)、[`../source-generators/cqrs-handler-registry-generator.md`](../source-generators/cqrs-handler-registry-generator.md) | request / notification / handler / pipeline / registry / fallback contract |
|
||||
| `Game` / `Game.Abstractions` / `Game.SourceGenerators` | [`GFramework.Game/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)、[`GFramework.Game.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)、[`GFramework.Game.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.SourceGenerators/README.md) | [`../game/index.md`](../game/index.md)、[`../abstractions/game-abstractions.md`](../abstractions/game-abstractions.md) | 配置、数据、设置、场景、UI、存储、序列化契约 |
|
||||
| `Godot` / `Godot.SourceGenerators` | [`GFramework.Godot/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot/README.md)、[`GFramework.Godot.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md) | [`../godot/index.md`](../godot/index.md)、[`../source-generators/godot-project-generator.md`](../source-generators/godot-project-generator.md)、[`../source-generators/get-node-generator.md`](../source-generators/get-node-generator.md)、[`../source-generators/bind-node-signal-generator.md`](../source-generators/bind-node-signal-generator.md) | 节点扩展、场景 / UI 适配、配置 / 存储 / 设置接线、Godot 生成器入口 |
|
||||
| `Ecs.Arch` / `Ecs.Arch.Abstractions` | [`GFramework.Ecs.Arch/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch/README.md)、[`GFramework.Ecs.Arch.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch.Abstractions/README.md) | [`../ecs/index.md`](../ecs/index.md)、[`../ecs/arch.md`](../ecs/arch.md)、[`../abstractions/ecs-arch-abstractions.md`](../abstractions/ecs-arch-abstractions.md) | ECS 模块契约、系统适配、配置对象和运行时装配边界 |
|
||||
| `Core` / `Core.Abstractions` | [`GFramework.Core README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)、[`GFramework.Core.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.Abstractions/README.md) | [`Core 栏目`](../core/index.md)、[`Core 抽象层说明`](../abstractions/core-abstractions.md) | 架构入口、生命周期、命令 / 查询 / 事件 / 状态 / 资源 / 日志 / 配置 / 并发契约 |
|
||||
| `Cqrs` / `Cqrs.Abstractions` / `Cqrs.SourceGenerators` | [`GFramework.Cqrs README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs/README.md)、[`GFramework.Cqrs.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs.Abstractions/README.md)、[`GFramework.Cqrs.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs.SourceGenerators/README.md) | [`CQRS 栏目`](../core/cqrs.md)、[`CQRS Handler Registry 生成器`](../source-generators/cqrs-handler-registry-generator.md) | request / notification / handler / pipeline / registry / fallback contract |
|
||||
| `Game` / `Game.Abstractions` / `Game.SourceGenerators` | [`GFramework.Game README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)、[`GFramework.Game.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)、[`GFramework.Game.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.SourceGenerators/README.md) | [`Game 模块总览`](../game/index.md)、[`Game 抽象层说明`](../abstractions/game-abstractions.md) | 配置、数据、设置、场景、UI、存储、序列化契约 |
|
||||
| `Godot` / `Godot.SourceGenerators` | [`GFramework.Godot README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot/README.md)、[`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md) | [`Godot 模块总览`](../godot/index.md)、[`Godot 项目生成器`](../source-generators/godot-project-generator.md)、[`GetNode 生成器`](../source-generators/get-node-generator.md)、[`BindNodeSignal 生成器`](../source-generators/bind-node-signal-generator.md) | 节点扩展、场景 / UI 适配、配置 / 存储 / 设置接线、Godot 生成器入口 |
|
||||
| `Ecs.Arch` / `Ecs.Arch.Abstractions` | [`GFramework.Ecs.Arch README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch/README.md)、[`GFramework.Ecs.Arch.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch.Abstractions/README.md) | [`ECS 模块总览`](../ecs/index.md)、[`Arch ECS 集成`](../ecs/arch.md)、[`Ecs.Arch 抽象层说明`](../abstractions/ecs-arch-abstractions.md) | ECS 模块契约、系统适配、配置对象和运行时装配边界 |
|
||||
|
||||
## 先看 XML，还是先看教程
|
||||
|
||||
|
||||
@ -186,4 +186,4 @@ RegisterCqrsPipelineBehavior<LoggingBehavior<,>>();
|
||||
- 架构入口：[architecture](./architecture.md)
|
||||
- 上下文入口：[context](./context.md)
|
||||
- 生成器专题：[../source-generators/cqrs-handler-registry-generator.md](../source-generators/cqrs-handler-registry-generator.md)
|
||||
- 模块 README：[`GFramework.Cqrs/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs/README.md)
|
||||
- 模块 README：[`GFramework.Cqrs README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs/README.md)
|
||||
|
||||
@ -71,7 +71,7 @@ dotnet add package GeWuYou.GFramework.Core.Abstractions
|
||||
|
||||
如果你已经知道模块归属，但想确认公开类型的契约边界，建议按下面顺序阅读：
|
||||
|
||||
1. 先看模块 README [`GFramework.Core/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)，确认包关系和目录边界
|
||||
1. 先看模块 README [`GFramework.Core`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)，确认包关系和目录边界
|
||||
2. 再看本栏目对应专题页，确认采用顺序、生命周期与推荐接线方式
|
||||
3. 最后回到源码中的 XML 文档，重点核对这些类型族：
|
||||
- `Architecture` / `IArchitectureContext`
|
||||
@ -148,7 +148,7 @@ public sealed class CounterArchitecture : Architecture
|
||||
|
||||
## 对应模块入口
|
||||
|
||||
- [`GFramework.Core/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)
|
||||
- [`GFramework.Core.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.Abstractions/README.md)
|
||||
- [`docs/zh-CN/api-reference/index.md`](../api-reference/index.md)
|
||||
- [`GFramework.Core README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core/README.md)
|
||||
- [`GFramework.Core.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.Abstractions/README.md)
|
||||
- [API 参考入口](../api-reference/index.md)
|
||||
- 仓库根 [`README.md`](https://github.com/GeWuYou/GFramework/blob/main/README.md)
|
||||
|
||||
@ -140,5 +140,5 @@ ecsModule.Update(deltaTime);
|
||||
|
||||
- ECS 模块总览：[`index.md`](./index.md)
|
||||
- 抽象契约页：[`../abstractions/ecs-arch-abstractions.md`](../abstractions/ecs-arch-abstractions.md)
|
||||
- 仓库模块 README：[`GFramework.Ecs.Arch/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch/README.md)
|
||||
- 仓库模块 README：[`GFramework.Ecs.Arch README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Ecs.Arch/README.md)
|
||||
- 统一 API / XML 导航：[`../api-reference/index.md`](../api-reference/index.md)
|
||||
|
||||
@ -127,6 +127,6 @@ IStorage storage = new FileStorage("GameData", serializer);
|
||||
|
||||
## 对应模块入口
|
||||
|
||||
- [`GFramework.Game/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
- [`GFramework.Game.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
- [`GFramework.Game README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
- [`GFramework.Game.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
- 仓库根 [`README.md`](https://github.com/GeWuYou/GFramework/blob/main/README.md)
|
||||
|
||||
@ -258,5 +258,5 @@ await sceneRouter.PopAsync();
|
||||
|
||||
1. [game/index.md](./index.md)
|
||||
2. [ui.md](./ui.md)
|
||||
3. [`GFramework.Game/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
4. [`GFramework.Game.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
3. [`GFramework.Game README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
4. [`GFramework.Game.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
|
||||
@ -329,5 +329,5 @@ uiRouter.Hide(modalHandle, UiLayer.Modal);
|
||||
1. [game/index.md](./index.md)
|
||||
2. [scene.md](./scene.md)
|
||||
3. [../source-generators/auto-ui-page-generator.md](../source-generators/auto-ui-page-generator.md)
|
||||
4. [`GFramework.Game/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
5. [`GFramework.Game.Abstractions/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
4. [`GFramework.Game README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
5. [`GFramework.Game.Abstractions README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.Abstractions/README.md)
|
||||
|
||||
@ -51,7 +51,7 @@ description: 概览 GFramework 的模块组成、最小接入路径与继续阅
|
||||
对应文档：
|
||||
|
||||
- [`../core/cqrs.md`](../core/cqrs.md)
|
||||
- 仓库内模块入口：[`GFramework.Cqrs/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs/README.md)
|
||||
- 仓库内模块入口：[`GFramework.Cqrs README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs/README.md)
|
||||
|
||||
### 想做游戏运行时
|
||||
|
||||
@ -70,7 +70,7 @@ description: 概览 GFramework 的模块组成、最小接入路径与继续阅
|
||||
对应文档：
|
||||
|
||||
- [`../game/index.md`](../game/index.md)
|
||||
- 仓库内模块入口：[`GFramework.Game/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
- 仓库内模块入口：[`GFramework.Game README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game/README.md)
|
||||
|
||||
### 想接入 Godot
|
||||
|
||||
@ -81,7 +81,7 @@ description: 概览 GFramework 的模块组成、最小接入路径与继续阅
|
||||
对应文档：
|
||||
|
||||
- [`../godot/index.md`](../godot/index.md)
|
||||
- 仓库内模块入口：[`GFramework.Godot/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot/README.md)
|
||||
- 仓库内模块入口：[`GFramework.Godot README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot/README.md)
|
||||
|
||||
## Source Generators 什么时候装
|
||||
|
||||
|
||||
@ -104,7 +104,7 @@ slider.Signal(Range.SignalName.ValueChanged)
|
||||
|
||||
### 4. 静态场景绑定优先交给 `[BindNodeSignal]`
|
||||
|
||||
从 `GFramework.Godot.SourceGenerators/README.md` 和 `ai-libs/CoreGrid` 的当前接法看，静态场景按钮、滑条、菜单项这类固定
|
||||
从 [`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md) 和 `ai-libs/CoreGrid` 的当前接法看，静态场景按钮、滑条、菜单项这类固定
|
||||
节点，更常见的路径仍然是 `[BindNodeSignal]`：
|
||||
|
||||
```csharp
|
||||
|
||||
@ -220,4 +220,4 @@ public List<IntConfig>? Values { get; } = new();
|
||||
1. [/zh-CN/source-generators/index](./index.md)
|
||||
2. [/zh-CN/game/config-system](../game/config-system.md)
|
||||
3. [/zh-CN/source-generators/godot-project-generator](./godot-project-generator.md)
|
||||
4. [`GFramework.Godot.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
4. [`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
|
||||
@ -189,4 +189,4 @@ private void OnAnyButtonPressed()
|
||||
1. [/zh-CN/source-generators/get-node-generator](./get-node-generator.md)
|
||||
2. [/zh-CN/source-generators/godot-project-generator](./godot-project-generator.md)
|
||||
3. [/zh-CN/godot/ui](../godot/ui.md)
|
||||
4. [`GFramework.Godot.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
4. [`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
|
||||
@ -195,4 +195,4 @@ finally
|
||||
1. [context-get-generator.md](./context-get-generator.md)
|
||||
2. [logging-generator.md](./logging-generator.md)
|
||||
3. [../core/index.md](../core/index.md)
|
||||
4. [`GFramework.Core.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.SourceGenerators/README.md)
|
||||
4. [`GFramework.Core.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.SourceGenerators/README.md)
|
||||
|
||||
@ -195,4 +195,4 @@ public override void _Ready()
|
||||
1. [/zh-CN/source-generators/bind-node-signal-generator](./bind-node-signal-generator.md)
|
||||
2. [/zh-CN/source-generators/godot-project-generator](./godot-project-generator.md)
|
||||
3. [/zh-CN/godot/ui](../godot/ui.md)
|
||||
4. [`GFramework.Godot.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
4. [`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
|
||||
@ -217,4 +217,4 @@ AutoLoad 名称也遵循同样的冲突处理策略。
|
||||
1. [/zh-CN/source-generators/get-node-generator](./get-node-generator.md)
|
||||
2. [/zh-CN/source-generators/bind-node-signal-generator](./bind-node-signal-generator.md)
|
||||
3. [/zh-CN/tutorials/godot-integration](../tutorials/godot-integration.md)
|
||||
4. [`GFramework.Godot.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
4. [`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
|
||||
@ -101,7 +101,7 @@ GFramework 当前发布的生成器包是：
|
||||
|
||||
## 对应模块入口
|
||||
|
||||
- [`GFramework.Core.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.SourceGenerators/README.md)
|
||||
- [`GFramework.Game.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.SourceGenerators/README.md)
|
||||
- [`GFramework.Cqrs.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs.SourceGenerators/README.md)
|
||||
- [`GFramework.Godot.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
- [`GFramework.Core.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.SourceGenerators/README.md)
|
||||
- [`GFramework.Game.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Game.SourceGenerators/README.md)
|
||||
- [`GFramework.Cqrs.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Cqrs.SourceGenerators/README.md)
|
||||
- [`GFramework.Godot.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Godot.SourceGenerators/README.md)
|
||||
|
||||
@ -213,4 +213,4 @@ public sealed class DynamicPrioritySystem : IPrioritized
|
||||
1. [context-aware-generator.md](./context-aware-generator.md)
|
||||
2. [context-get-generator.md](./context-get-generator.md)
|
||||
3. [../core/index.md](../core/index.md)
|
||||
4. [`GFramework.Core.SourceGenerators/README.md`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.SourceGenerators/README.md)
|
||||
4. [`GFramework.Core.SourceGenerators README`](https://github.com/GeWuYou/GFramework/blob/main/GFramework.Core.SourceGenerators/README.md)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user