gewuyou/GFramework
1
0
Fork 0
mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-13 06:04:30 +08:00
Code Issues Packages Projects Releases Wiki Activity
GFramework/ai-plan/public/documentation-governance-and-refresh/traces/documentation-governance-and-refresh-trace.md
GeWuYou 233195df91 docs(core): 补齐导航链接并收口追踪告警 
- 更新 core landing page 的 Godot 与 Source Generators 导航入口为可点击链接
- 修复 documentation-governance-and-refresh active trace 的重复标题并消除 MD024 告警
- 补充 tracking 与 trace 的恢复点、验证记录和 PR review 跟进结论
2026-04-21 12:34:37 +08:00

6.9 KiB
Raw Blame History

Documentation Governance And Refresh 追踪

2026-04-19

阶段：local-plan 迁移收口（RP-001）

  • 复核当前工作树后确认：worktree 根目录仅剩一个 legacy local-plan/，其内容属于文档治理与重写主题的 durable recovery state，不应继续作为独立根目录入口存在
  • 按 ai-plan 治理规则建立 ai-plan/public/documentation-governance-and-refresh/ 主题目录，并补齐：
    • todos/
    • traces/
    • archive/todos/
    • archive/traces/
  • 将原 local-plan 中的详细 tracking / trace 迁入主题内历史归档，并为 active 入口只保留当前恢复点、 活跃事实、风险与下一步
  • 在 ai-plan/public/README.md 中建立 docs/sdk-update-documentation -> documentation-governance-and-refresh 的 worktree 映射
  • 同步更新 ai-plan-governance 的 tracking / trace，记录本次迁移已验证当前工作树不再依赖 worktree-root local-plan/

Archive Context

  • 历史跟踪归档：
    • ai-plan/public/documentation-governance-and-refresh/archive/todos/documentation-governance-and-refresh-history-through-2026-04-18.md
  • 历史 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/

2026-04-21

阶段：栏目 landing page 收口（RP-002）

  • 依据 ai-plan/public/README.md 的 worktree 映射恢复 documentation-governance-and-refresh 主题，并确认该分支下一步应优先处理 docs/zh-CN/core/*、game/* 与 source-generators/*
  • 复核 docs/zh-CN/core/index.md、docs/zh-CN/game/index.md、docs/zh-CN/source-generators/index.md 后确认：这三页仍保留旧版“大而全教程”结构，与当前模块 README、包拆分关系和推荐接入路径明显漂移
  • 对照 GFramework.Core/README.md、GFramework.Game/README.md、GFramework.Core.SourceGenerators/README.md、 GFramework.Game.SourceGenerators/README.md、GFramework.Cqrs.SourceGenerators/README.md 与 GFramework.Godot.SourceGenerators/README.md，重写三个栏目 landing page，使其回到“模块定位、包关系、最小接入路径、继续阅读”的可信入口形态
  • 首次执行 cd docs && bun run build 时发现 VitePress 会把跳到 docs/ 目录外的相对链接判定为 dead link，因此将 landing page 末尾的模块 README 入口改为纯文本路径提示而非站内链接
  • 第二次执行 cd docs && bun run build 通过，说明当前 landing page 重写没有破坏站点构建

当前结论

  • 当前默认导航入口已显著收敛，但专题页仍需逐页按源码与测试继续核对
  • 后续优先级应从 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 名称与应保留的最小示例
  3. 完成一轮专题页重写后再次执行 cd docs && bun run build

补充：2026-04-21 内容引用迁移

  • 按当前文档治理主题，继续清理活跃规范与面向读者的内容入口中的旧参考仓库命名
  • AGENTS.md 已把“secondary evidence source”从特定项目名收口为 ai-libs/ 下的已验证只读参考实现
  • GFramework.Game/README.md、GFramework.Game.Abstractions/README.md 与 docs/zh-CN/game/index.md 已同步改为 ai-libs/ 参考表述，并去掉特定参考项目名称与项目内类型名线索
  • documentation-governance-and-refresh active tracking 已同步把风险缓解中的参考来源更新为 ai-libs/ 下已验证参考实现
  • 下一次专题页重写时，继续沿用同一表述，不再把特定参考项目名写入新的活跃文档入口

补充：2026-04-21 Core 专题页收口（RP-003）

  • 复核 docs/zh-CN/core/architecture.md、context.md、lifecycle.md、command.md、query.md 与 cqrs.md 后确认：这些页面仍大量保留旧 API 叙述，例如 Init()、属性式 CommandBus / QueryBus、旧 Input 赋值式命令/查询示例，以及已移除的 RegisterMediatorBehavior
  • 对照 Architecture、ArchitectureContext、IArchitectureContext、ContextAwareBase、旧 AbstractCommand / AbstractQuery 基类和 GFramework.Cqrs/README.md 后，重写上述六个页面
  • 新版专题页将结构统一为“当前角色、真实公开入口、最小示例、兼容边界、迁移方向”，避免继续复刻旧版大而全教程
  • core/context.md 已明确把 GameContext 收束为兼容回退路径，而不是新代码的推荐接法
  • core/command.md 与 core/query.md 已明确旧体系仍可用，但新功能应优先走 GFramework.Cqrs
  • core/cqrs.md 已与当前 runtime / generator / handler 注册语义对齐，并明确 RegisterCqrsPipelineBehavior<TBehavior>() 是公开入口
  • 执行 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 明确告警

  4. 继续处理 docs/zh-CN/core/events.md、property.md、state-management.md、coroutine.md、logging.md

  5. 保持同样的证据顺序：源码、*.csproj、模块 README、ai-libs/ 参考实现

  6. 完成下一批专题页重写后再次执行 cd docs && bun run build