From 233195df91abc3c1b4d4bdbdce1409da1c5d29cf Mon Sep 17 00:00:00 2001 From: GeWuYou <95328647+GeWuYou@users.noreply.github.com> Date: Tue, 21 Apr 2026 12:34:37 +0800 Subject: [PATCH] =?UTF-8?q?docs(core):=20=E8=A1=A5=E9=BD=90=E5=AF=BC?= =?UTF-8?q?=E8=88=AA=E9=93=BE=E6=8E=A5=E5=B9=B6=E6=94=B6=E5=8F=A3=E8=BF=BD?= =?UTF-8?q?=E8=B8=AA=E5=91=8A=E8=AD=A6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 更新 core landing page 的 Godot 与 Source Generators 导航入口为可点击链接 - 修复 documentation-governance-and-refresh active trace 的重复标题并消除 MD024 告警 - 补充 tracking 与 trace 的恢复点、验证记录和 PR review 跟进结论 --- ...ntation-governance-and-refresh-tracking.md | 12 ++++++-- ...umentation-governance-and-refresh-trace.md | 29 +++++++++++++++++-- docs/zh-CN/core/index.md | 2 +- 3 files changed, 37 insertions(+), 6 deletions(-) diff --git a/ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md b/ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md index a3f984b8..4dd0f89c 100644 --- a/ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md +++ b/ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md @@ -7,7 +7,7 @@ ## 当前恢复点 -- 恢复点编号：`DOCUMENTATION-GOVERNANCE-REFRESH-RP-003` +- 恢复点编号：`DOCUMENTATION-GOVERNANCE-REFRESH-RP-004` - 当前阶段：`Phase 3` - 当前焦点： - 已完成 `docs/zh-CN/core/architecture.md`、`context.md`、`lifecycle.md`、`command.md`、`query.md` 与 @@ -32,6 +32,10 @@ - `docs` 站点构建已验证通过，修正了 VitePress 对 `docs/` 目录外相对链接的 dead-link 检查问题 - `core` 关键专题页已移除 `Init()`、属性式 `CommandBus` / `QueryBus`、旧 `Input` 赋值式示例和已移除的 `RegisterMediatorBehavior` 等过时说明 +- `core/index.md` 已把 `Godot` 与 `Source Generators` 栏目入口改成可点击链接，补齐 landing page 导航一致性 +- `documentation-governance-and-refresh` active trace 已把重复的 `### 下一步` 标题改成带恢复点标识的唯一标题，消除 + `MD024/no-duplicate-heading` 告警 +- `gframework-pr-review` 脚本已修复“空 `APPROVED` review 覆盖非空 CodeRabbit review body”的解析路径，当前分支可重新提取 Nitpick comments ## 当前风险 @@ -42,6 +46,9 @@ - 缓解措施：保持“源码与包关系优先”的证据顺序，改动采用说明时同步核对包依赖与生成器 wiring - Active 入口回膨胀风险：后续若把栏目级重写过程直接追加到 active 文档，会再次拖慢恢复 - 缓解措施：阶段完成并验证后，继续把细节迁入本 topic 的 `archive/` +- review 跟进遗漏风险：如果 PR review 抓取继续优先选中空 review body，会漏掉 CodeRabbit 的 Nitpick 和 + linter 跟进项 + - 缓解措施：保持当前“最新提交 + 最新非空 CodeRabbit review body”解析策略，并在有疑点时以 API 实抓结果复核 ## 活跃文档 @@ -53,10 +60,11 @@ - 旧 `local-plan/` 的详细实施历史与文档站构建结果已迁入主题内归档 - active 跟踪文件已按 `ai-plan` 治理规则精简为当前恢复入口 - `cd docs && bun run build` +- `python3 .codex/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --format json` ## 下一步 1. 继续核对 `docs/zh-CN/core/*` 余下专题页，优先处理 `events`、`property`、`state-management`、`coroutine` 与 `logging` 2. 再推进 `docs/zh-CN/game/*` 与 `docs/zh-CN/source-generators/*` 的专题页重写，优先处理仍引用旧安装方式或旧 API 的页面 -3. 若专题页批量重写完成且验证通过，将本轮 `core` 专题页收口和后续修订过程迁入本 topic 的 `archive/` +3. 若 active trace 再积累新的已完成阶段，按恢复点粒度迁入 `archive/traces/`，避免默认启动入口再次膨胀 diff --git a/ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md b/ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md index bea860e5..c8f4130d 100644 --- a/ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md +++ b/ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md @@ -25,7 +25,7 @@ - 历史 trace 归档： - `ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-18.md` -### 下一步 +### 下一步（RP-001） 1. 后续继续该主题时，只从 `ai-plan/public/documentation-governance-and-refresh/` 进入，不再恢复 `local-plan/` 2. 若 active 入口再次积累多轮已完成且已验证阶段，继续按同一模式迁入该主题自己的 `archive/` @@ -47,7 +47,7 @@ - 当前默认导航入口已显著收敛，但专题页仍需逐页按源码与测试继续核对 - 后续优先级应从 `core` 专题页开始，再向 `game` 与 `source-generators` 扩展 -### 下一步 +### 下一步（RP-002） 1. 审核 `docs/zh-CN/core/architecture.md`、`context.md`、`lifecycle.md`、`command.md`、`query.md`、`cqrs.md` 2. 记录每页的失真点、真实 API 名称与应保留的最小示例 @@ -77,7 +77,30 @@ 是公开入口 - 执行 `cd docs && bun run build` 通过，说明本轮 `core` 专题页重写没有破坏文档站构建 -### 下一步 +### 下一步（RP-003） + +### 补充：2026-04-21 PR review 跟进收口（RP-004） + +- 通过 `gframework-pr-review` 复查当前分支 PR 时发现：脚本把同一 head commit 上空 body 的 `APPROVED` + review 误当成“最新 review body”，导致 `Nitpick comments` 未被结构化提取 +- 对照 GitHub API 的 review 列表后，确认真正包含 `Nitpick comments (2)` 的是更早 3 秒提交的 + `COMMENTED` review；因此调整脚本为“保持最新 review 元数据输出不变，但解析时优先选择同一提交上的最新非空 + CodeRabbit review body” +- 根据重新提取的 Nitpick 内容，补齐 `docs/zh-CN/core/index.md` 里 `Godot` 与 `Source Generators` + 栏目的可点击链接 +- 顺手修正 active trace 中重复的 `### 下一步` 标题，消除 `MD024/no-duplicate-heading` 告警，避免后续 PR + review 再次把文档治理入口本身标成噪音 + +### 验证（RP-004） + +- `python3 .codex/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --format json` +- `cd docs && bun run build` + +### 下一步（RP-004） + +1. 继续处理 `docs/zh-CN/core/events.md`、`property.md`、`state-management.md`、`coroutine.md`、`logging.md` +2. 若 active trace 继续累计多个已完成恢复点，按 `archive/traces/` 粒度归档旧阶段细节 +3. 保持 PR review 跟进时优先验证最新未解决线程、非空 CodeRabbit review body 与 MegaLinter 明确告警 1. 继续处理 `docs/zh-CN/core/events.md`、`property.md`、`state-management.md`、`coroutine.md`、`logging.md` 2. 保持同样的证据顺序：源码、`*.csproj`、模块 README、`ai-libs/` 参考实现 diff --git a/docs/zh-CN/core/index.md b/docs/zh-CN/core/index.md index 306dabf7..d8a600a6 100644 --- a/docs/zh-CN/core/index.md +++ b/docs/zh-CN/core/index.md @@ -88,7 +88,7 @@ public sealed class CounterArchitecture : Architecture - 要接入游戏内容配置、设置、数据仓库、Scene 或 UI： - 转到 [Game](../game/index.md) - 要接入 Godot 节点、场景和项目元数据生成： - - 转到 `Godot` 与 Source Generators 栏目 + - 转到 [Godot](../godot/index.md) 与 [Source Generators](../source-generators/index.md) 栏目 ## 推荐阅读顺序