diff --git a/ai-plan/public/README.md b/ai-plan/public/README.md index fdae3d71..74fad82f 100644 --- a/ai-plan/public/README.md +++ b/ai-plan/public/README.md @@ -38,10 +38,6 @@ help the current worktree land on the right recovery documents without scanning - Purpose: continue the data repository persistence hardening plus the settings / serialization follow-up backlog. - Tracking: `ai-plan/public/data-repository-persistence/todos/data-repository-persistence-tracking.md` - Trace: `ai-plan/public/data-repository-persistence/traces/data-repository-persistence-trace.md` -- `documentation-governance-and-refresh` - - Purpose: continue the documentation governance, README hardening, and `docs/zh-CN` accuracy refresh work. - - Tracking: `ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md` - - Trace: `ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md` ## Worktree To Active Topic Map @@ -62,12 +58,11 @@ help the current worktree land on the right recovery documents without scanning - Branch: `feat/data-repository-persistence` - Worktree hint: `GFramework-data-repository-persistence` - Priority 1: `data-repository-persistence` -- Branch: `docs/sdk-update-documentation` - - Worktree hint: `GFramework-update-documentation` - - Priority 1: `documentation-governance-and-refresh` - ## Archived Topics - `cqrs-cache-docs-hardening` - Archive root: `ai-plan/public/archive/cqrs-cache-docs-hardening/` - Note: archived topics stay outside the default `boot` context until a user explicitly requests historical review. +- `documentation-governance-and-refresh` + - Archive root: `ai-plan/public/archive/documentation-governance-and-refresh/` + - Note: PR #268 已合并；文档治理与 Godot 栏目刷新阶段已完成，后续仅作为历史恢复材料保留。 diff --git a/ai-plan/public/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-18.md b/ai-plan/public/archive/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-18.md similarity index 100% rename from ai-plan/public/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-18.md rename to ai-plan/public/archive/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-18.md diff --git a/ai-plan/public/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md b/ai-plan/public/archive/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md similarity index 100% rename from ai-plan/public/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md rename to ai-plan/public/archive/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md diff --git a/ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-18.md b/ai-plan/public/archive/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-18.md similarity index 100% rename from ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-18.md rename to ai-plan/public/archive/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-18.md diff --git a/ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-22.md b/ai-plan/public/archive/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-22.md similarity index 100% rename from ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-22.md rename to ai-plan/public/archive/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-22.md diff --git a/ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-rp-001-through-rp-008.md b/ai-plan/public/archive/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-rp-001-through-rp-008.md similarity index 100% rename from ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-rp-001-through-rp-008.md rename to ai-plan/public/archive/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-rp-001-through-rp-008.md diff --git a/ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md b/ai-plan/public/archive/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md similarity index 52% rename from ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md rename to ai-plan/public/archive/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md index 1ffdb7d9..7ccc9ba0 100644 --- a/ai-plan/public/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md +++ b/ai-plan/public/archive/documentation-governance-and-refresh/todos/documentation-governance-and-refresh-tracking.md @@ -7,40 +7,34 @@ ## 当前恢复点 -- 恢复点编号：`DOCUMENTATION-GOVERNANCE-REFRESH-RP-018` -- 当前阶段：`Phase 3` +- 恢复点编号：`DOCUMENTATION-GOVERNANCE-REFRESH-RP-019` +- 当前阶段：`Completed` - 当前焦点： - - Godot 栏目本轮重写页已完成稳定性复核，当前可把详细实施历史迁入 `archive/` - - active tracking / trace 已收口为默认 `boot` 可直接恢复的最小入口 - - 下一次推送后需要重新执行 PR #268 review 跟进，确认 CodeRabbit / Greptile open thread 是否继续收敛 + - 用户已确认 PR #268 合并，本 topic 对应的文档治理收口工作完成 + - 当前目录将在本轮迁入 `ai-plan/public/archive/documentation-governance-and-refresh/` + - 后续若需历史回溯，应从 archive 中恢复，而不是继续把该 topic 作为 active 默认入口 ## 当前状态摘要 -- `docs/zh-CN/godot/` 当前高优先级页面集已完成源码优先收口： - `index.md`、`architecture.md`、`scene.md`、`ui.md`、`signal.md`、`extensions.md`、`logging.md` -- `docs/zh-CN/tutorials/godot-integration.md` 已与当前包关系、生成器协作顺序和运行时边界对齐 -- 本轮再次执行页面级校验与 `docs` 站点构建，结果均通过 -- 当前主题保持 active，但 active 文档已不再承载大段历史，只保留恢复所需事实与下一步 +- `docs/zh-CN/godot/` 当前高优先级页面集与 `docs/zh-CN/tutorials/godot-integration.md` 已完成源码优先收口 +- PR #268 已合并，上一轮保留 active 的唯一原因已经解除 +- 本 topic 已达到归档条件：实现完成、校验完成、PR 生命周期结束 ## 当前活跃事实 -- 当前分支 `docs/sdk-update-documentation` 仍映射到 `documentation-governance-and-refresh` -- 当前 worktree 下未发现 `ai-plan/private/` 恢复目录，本主题以 public artifacts 作为唯一恢复入口 -- 本轮新增归档： +- 当前 worktree 下未发现 `ai-plan/private/` 恢复目录，本主题一直以 public artifacts 作为唯一恢复入口 +- 已存在的阶段归档： - `ai-plan/public/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md` - `ai-plan/public/documentation-governance-and-refresh/archive/traces/documentation-governance-and-refresh-history-through-2026-04-22.md` - 2026-04-22 之前的长篇历史已存在于 2026-04-18 与 RP-001 through RP-008 的归档文件中 -- 当前待处理事项已经从“继续重写 Godot 页面”切换为“等待下一次推送后的 PR review follow-up” +- 当前待处理事项已清零；后续只保留历史查询价值 ## 当前风险 -- review 跟进遗漏风险：如果下一次推送后未重新抓取 PR #268 的 latest-head open threads，可能会错过新一轮 - CodeRabbit / Greptile 意见 - - 缓解措施：推送后优先执行 `$gframework-pr-review`，以 unresolved thread 数量变化作为下一步入口 -- active 文档再次膨胀风险：如果后续把细节实施记录继续直接追加到 active 文件，会重新削弱 `boot` 的恢复效率 - - 缓解措施：阶段性结果先写入 `archive/`，active 只保留恢复点、活跃事实、风险、验证和下一步 -- 文档回漂风险：若后续修改 README 或专题页时跳过源码 / 测试核对，可能把旧教程里的叙述重新写回当前页面 - - 缓解措施：继续维持“源码 / 测试 / `*.csproj` 优先，`ai-libs/` 只补 adoption path”的证据顺序 +- 后续历史定位风险：如果不把 topic 从 active 列表中移除，`boot` 会继续把已经完成的文档治理主题当作默认入口 + - 缓解措施：本轮同步更新 `ai-plan/public/README.md` 并把整个 topic 目录迁入 `ai-plan/public/archive/` +- 文档回漂风险：未来若有新的 README / `docs/zh-CN` 变更，仍可能重新引入与源码不一致的表述 + - 缓解措施：新任务应创建或复用新的 active topic，而不是重启当前已完成主题 ## 活跃文档 @@ -64,5 +58,5 @@ ## 下一步 -1. 下一次推送后执行 `$gframework-pr-review`，确认 PR #268 的 CodeRabbit / Greptile unresolved threads 是否继续减少 -2. 如果 review 已收敛且没有新增文档偏差，再评估是否将整个 topic 迁入 `ai-plan/public/archive/` +1. 将整个 `documentation-governance-and-refresh` 目录迁入 `ai-plan/public/archive/` +2. 从 `ai-plan/public/README.md` 删除该 topic 的 active 声明与 worktree 映射 diff --git a/ai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md b/ai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md new file mode 100644 index 00000000..e4deadfe --- /dev/null +++ b/ai-plan/public/archive/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md @@ -0,0 +1,25 @@ +# Documentation Governance And Refresh Trace + +## 2026-04-22 + +### 当前恢复点：RP-019 + +- 本轮按 `boot` 恢复 `documentation-governance-and-refresh` 主题 +- 用户明确说明 PR #268 已合并，因此该主题不再需要保持 active 以等待 review follow-up +- 当前主题满足完成条件：文档页已完成校验、`docs` 站点先前已构建通过、PR 生命周期结束 +- 本轮将把整个主题目录迁入 `ai-plan/public/archive/documentation-governance-and-refresh/` +- `ai-plan/public/README.md` 也将在本轮删除该 topic 的 active 声明与 worktree 映射 + +### 当前决策 + +- 当前主题正式归档，不再作为 `boot` 默认入口 +- 若未来出现新的文档治理任务，应创建新的 active topic 或挂到新的现役主题，而不是恢复本目录 +- 现有 tracking / trace 留在 archive 中作为历史恢复材料 + +### 验证 + +- `cd docs && bun run build` + +### 下一步 + +1. 若需回看本阶段历史，从 `ai-plan/public/archive/documentation-governance-and-refresh/` 读取归档材料 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 deleted file mode 100644 index 99bece59..00000000 --- a/ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md +++ /dev/null @@ -1,47 +0,0 @@ -# Documentation Governance And Refresh Trace - -## 2026-04-22 - -### 当前恢复点：RP-018 - -- 本轮按 `boot` 恢复 `documentation-governance-and-refresh` 主题，确认当前 worktree 映射与 active topic 一致 -- 本地复核确认 `ai-plan/private/` 目录不存在，当前恢复上下文完全来自 public tracking / trace -- 重新验证 Godot 栏目当前高优先级页面与教程页： - - `docs/zh-CN/godot/index.md` - - `docs/zh-CN/godot/architecture.md` - - `docs/zh-CN/godot/scene.md` - - `docs/zh-CN/godot/ui.md` - - `docs/zh-CN/godot/signal.md` - - `docs/zh-CN/godot/extensions.md` - - `docs/zh-CN/godot/logging.md` - - `docs/zh-CN/tutorials/godot-integration.md` -- 上述页面的 `validate-all.sh` 校验全部通过；`docs` 站点构建也通过 -- active tracking 先前为 `186` 行、active trace 为 `103` 行，已经超过默认恢复入口所需体量 -- 已把本轮之前的 active 内容归档到： - - `archive/todos/documentation-governance-and-refresh-history-through-2026-04-22.md` - - `archive/traces/documentation-governance-and-refresh-history-through-2026-04-22.md` -- active tracking / trace 已重写为精简入口，只保留恢复点、当前风险、验证结果和下一步 - -### 当前决策 - -- 当前主题继续保持 active，因为下一次推送后仍需跟进 PR #268 review 收敛情况 -- Godot 栏目页面集暂不继续扩写，除非新的 review 或源码变更暴露出实际偏差 -- 详细实施历史统一进入 `archive/`，active 文档不再承载长篇阶段记录 - -### 验证 - -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/index.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/architecture.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/scene.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/ui.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/signal.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/extensions.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/godot/logging.md` -- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/tutorials/godot-integration.md` -- `cd docs && bun run build` - -### 下一步 - -1. 下一次推送后重新执行 `$gframework-pr-review` -2. 根据 PR #268 unresolved thread 的变化决定是否还需要新一轮文档修正 -3. 若无新增修正项，考虑将整个 `documentation-governance-and-refresh` topic 迁入 `ai-plan/public/archive/`