docs(pr-review): 收口评审遗留文档措辞

- 更新 Core 与 Core.Abstractions README 的 reader-facing 文案,移除公开入口中的 inventory 表述
- 修复仓库根 README 的贡献指引范围,明确同步受影响的中文文档页面
- 补充 active tracking 与 trace 的 PR #284 follow-up 恢复点和验证结果
This commit is contained in:
gewuyou 2026-04-24 16:45:48 +08:00
parent 77540c07f0
commit 546e6c7b11
5 changed files with 25 additions and 25 deletions

View File

@ -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 与阅读顺序见 [Core 抽象层说明](../docs/zh-CN/abstractions/core-abstractions.md)。
完整接入说明与阅读顺序见 [Core 抽象层说明](../docs/zh-CN/abstractions/core-abstractions.md)。
## 采用建议

View File

@ -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 说明见 [Core 栏目](../docs/zh-CN/core/index.md)。
完整的模块化接入说明和阅读顺序见 [Core 栏目](../docs/zh-CN/core/index.md)。
## 最小接入路径

View File

@ -146,7 +146,7 @@ GFramework.sln
提交功能或行为变更时,请把代码、测试和文档一起更新:
1. 先阅读对应模块目录下的 `README.md`
2. 如果改动影响采用路径、安装方式、公共 API 或目录结构,同时更新 [中文文档入口](docs/zh-CN/index.md)
2. 如果改动影响采用路径、安装方式、公共 API 或目录结构,同时更新受影响的中文文档页面,必要时同步调整 [中文文档入口](docs/zh-CN/index.md)
3. 对跨模块或多阶段任务,维护 `ai-plan/public/README.md` 与对应主题目录下的 tracking / trace
## 许可证

View File

@ -25,9 +25,9 @@
## 当前状态摘要
- `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-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 thread4 条建议均已在本地复核并纳入当前恢复点
- `2026-04-24` 当前分支累计 diff 已接近 `$gframework-batch-boot 75` 的 stop condition`58 / 75` 个 changed files后续 follow-up 应继续保持小 write set只处理仍然成立的 PR review 项
- `2026-04-24` 使用 `$gframework-pr-review` 抓取当前 PR `#284` 后,确认 latest head commit
`77540c07f0890cc05b10a849722c87b8bed8f561` 仍有 `3` 条 CodeRabbit 与 `1` 条 Greptile open thread本轮仅继续收口本地复核后仍成立的 reader-facing 文档入口与 active tracking 精简问题
- 本轮 PR follow-up 仅收口仍然成立的 review 项:
- 将过长的 active tracking / trace 瘦身,并把 `RP-023``RP-025` 的细节迁入 `archive/`
- 将 `docs/zh-CN/core/context.md` 的标题本地化为中文读者友好的写法
@ -66,8 +66,8 @@
## 最新验证
- `2026-04-24` `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --format json --json-output /tmp/current-pr-review.json`
- 结果通过PR `#282` 处于 `OPEN`latest head commit`3` 条 CodeRabbit 与 `1` 条 Greptile open thread测试汇总为 `2156 passed`,仅剩 `Title check` 的 inconclusive PR 元数据提示。
- `2026-04-24` `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/current-pr-review.json`
- 结果通过PR `#284` 处于 `OPEN`latest head commit `77540c07f0890cc05b10a849722c87b8bed8f561``3` 条 CodeRabbit 与 `1` 条 Greptile open thread测试汇总为 `2156 passed`,仅剩 `Title check` 的 inconclusive PR 元数据提示。
- `2026-04-24` `rg -n --pcre2 '\\]\\(/zh-CN/[^)]+(?<!\\.md)\\)' docs/zh-CN/troubleshooting.md`
- 结果:当前无命中;`/zh-CN/core/architecture``/zh-CN/faq` 已统一补成显式 `.md` 链接。
- `2026-04-24` `bun run build`(工作目录:`docs/`
@ -85,8 +85,8 @@
## 下一步
1. 当前分支达到 `58 / 75` 个 changed files 后,若继续执行 `$gframework-batch-boot 75`,应优先选择 `5``10` 个文件以内的小批次,避免显著降低 reviewability。
2. 推送当前批次 commit 后,再次执行 `$gframework-pr-review`,确认 PR `#282` 的 unresolved review threads 是否已在新 head commit 上消失。
1. 当前分支已接近 `$gframework-batch-boot 75` 的 stop condition若继续执行后续批次,应优先选择 `5``10` 个文件以内的小批次,避免显著降低 reviewability。
2. 推送当前批次 commit 后,再次执行 `$gframework-pr-review`,确认 PR `#284` 的 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 是否仍保持同一套职责边界。
4. 若后续分支继续调整 `Godot` generator 接法,优先复核 `GFramework.Godot.SourceGenerators/README.md`

View File

@ -2,25 +2,25 @@
## 2026-04-24
### 当前恢复点RP-029
### 当前恢复点RP-030
- `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` 入口更新
- 当前 follow-up 聚焦 `$gframework-pr-review` 在 PR `#284` 上仍然成立的 review 项,只处理公开 README 的 reader-facing 文案与 active tracking 精简问题
- `origin/main``a8447a6``2026-04-24T12:53:39+08:00`)为 `$gframework-batch-boot 75` baseline当前分支 cumulative diff 已接近 stop condition应继续把 write set 控制在小批次范围内
- 本批次计划修改 `3` 个 README 与 `2``ai-plan` 入口文件,避免再次扩张到跨模块文档面
### 当前决策RP-029
### 当前决策RP-030
- 当 branch diff 接近 `58 / 75` 时,继续批量推进的前提应变成“每批只有很小的 write set 且收益明确”;否则优先停在当前恢复点,保留 reviewability
- README 与 landing page 的 reader-facing 入口应优先显示模块名、栏目名或功能名,而不是直接暴露仓库路径
- `docs/index.md` 作为语言落地页,即使主要依赖脚本跳转,也应保留明确的 `title` / `description` metadata避免站点入口缺失基础说明
- 当 branch diff 已接近 `$gframework-batch-boot 75` 的阈值时PR follow-up 只继续收口最新 head commit 上仍未消失、且能在本地验证成立的 review 线程
- 公开 README 不再使用 `inventory` 这类治理语境,也不把贡献指引缩窄到单一入口页;文案应明确“受影响页面”与“接入说明/阅读顺序”
- active tracking 需要保留恢复点与风险信息,但不再保留完整 commit SHA、精确时间戳与拆分式文件计数这类过细基线指标
### 当前验证RP-029
### 当前验证RP-030
- 站点构建
- `bun run build`(工作目录:`docs/`
- 结果:通过;模块 README、中文落地页 reader-facing 文档入口对齐,以及 `docs/index.md` metadata 调整后站点仍可正常构建,仅保留既有大 chunk warning
- PR review 抓取
- `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/current-pr-review.json`
- 结果:通过;PR `#284` 处于 `OPEN`latest head commit `77540c07f0890cc05b10a849722c87b8bed8f561` 仍有 `3` 条 CodeRabbit 与 `1` 条 Greptile open thread测试汇总为 `2156 passed`,仅剩 `Title check` 的 inconclusive PR 元数据提示
- 当前 stop-condition metric
- 本批次 write set 为 `31` 个文件(`29` 个 README / docs 页面 + `2``ai-plan` 入口);本批次提交后分支 diff 为 `58 / 75` 个 changed files
- 分支 cumulative diff 已接近 `58 / 75`;本轮 follow-up 继续限制在 `3` 个 README 与 `2``ai-plan` 入口文件内
### 归档指针
@ -32,5 +32,5 @@
### 下一步
1. 若继续执行 `$gframework-batch-boot 75`,优先选择 `5``10` 个文件以内的小批次,例如剩余零散的 README 路径引用或单页 reader-facing 标签修正
2. 推送本批次 commit 后,再次执行 `$gframework-pr-review`,确认 PR `#282` 的 unresolved review threads 是否已在新 head commit 上消失
1. 推送本批次 commit 后,再次执行 `$gframework-pr-review`,确认 PR `#284` 的 unresolved review threads 是否已在新 head commit 上消失
2. 若继续执行 `$gframework-batch-boot 75`,优先选择 `5``10` 个文件以内的小批次,例如剩余零散的 README reader-facing 文案修正