mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-13 06:04:30 +08:00
8a117201d4
- 更新专题页推荐阅读中的 README 入口为可点击 GitHub 链接 - 修复 source-generators 与 Game/ECS/CQRS 页面中的裸路径导航 - 更新 documentation-full-coverage-governance 跟踪与轨迹以记录第二批治理结果
54 lines
3.6 KiB
Markdown
54 lines
3.6 KiB
Markdown
# Documentation Full Coverage Governance Trace
|
||
|
||
## 2026-04-23
|
||
|
||
### 当前恢复点：RP-023
|
||
|
||
- 按当前使用反馈继续执行 `documentation-full-coverage-governance` 下的 skill 文档治理。
|
||
- 本轮目标定义为“继续沿用上一批的 GitHub 外链策略，收口专题页里的裸路径 README 入口”。
|
||
- 本轮执行的修复：
|
||
- 将 `docs/zh-CN/core/cqrs.md` 与 `ecs/arch.md` 的仓库 README 入口改为 GitHub `main` blob 外链
|
||
- 将 `docs/zh-CN/abstractions/ecs-arch-abstractions.md`、`game/scene.md`、`game/ui.md` 的回跳 README 入口改为可点击链接
|
||
- 将 `docs/zh-CN/source-generators/priority-generator.md`、`context-aware-generator.md`、
|
||
`bind-node-signal-generator.md`、`godot-project-generator.md`、`get-node-generator.md`、
|
||
`auto-register-exported-collections-generator.md` 的推荐阅读 README 入口改为可点击链接
|
||
- 同步更新 active tracking / trace，记录第二批导航治理与新的恢复点
|
||
|
||
### 当前决策（RP-023）
|
||
|
||
- 继续使用 `origin/main` 作为 `$gframework-batch-boot 75` 的固定基线，并以“分支累计 diff 文件数”作为主状态指标。
|
||
- 对文档治理类批次，优先选择“导航可达性 / 渲染一致性”这类不改变产品语义的低风险切片。
|
||
- 在 docs 页面里出现仓库内 README 路径时，优先使用可点击的相对链接，而不是裸路径代码片段。
|
||
- 当 docs 页需要跳转到 `docs/` 外部的 README 时，使用 GitHub `main` 分支 blob 外链，而不是跨出 `docs/` 根目录的相对路径。
|
||
- 第二批继续沿用同一外链策略，避免在同一 docs surface 中混用“裸路径 / 相对死链 / GitHub 外链”三套入口风格。
|
||
|
||
### 当前验证（RP-023）
|
||
|
||
- 导航热点巡检：
|
||
- `rg -n '`GFramework\\.[^`]+/README\\.md`|`docs/zh-CN/[^`]+\\.md`|仓库根 `README\\.md`' docs/zh-CN -g '*.md'`
|
||
- 结果：命中 landing / API 导航页中的裸路径仓库入口，已按本轮批次收口 7 个页面。
|
||
- 第二批专题页巡检：
|
||
- `rg -n '`GFramework\\.[^`]+/README\\.md`|仓库根 `README\\.md`' docs/zh-CN -g '*.md'`
|
||
- 结果：命中 `core/cqrs.md`、`ecs/arch.md`、`abstractions/ecs-arch-abstractions.md`、`game/scene.md`、
|
||
`game/ui.md` 与 6 个 `source-generators/*.md` 专题页，均已修复。
|
||
- 构建校验：
|
||
- `bun run build`（工作目录：`docs/`）
|
||
- 结果：通过；将仓库 README 跳转改为 GitHub `main` blob 外链后，不再触发 VitePress dead link；仅保留既有大 chunk warning。
|
||
|
||
### 归档摘要（RP-022）
|
||
|
||
- 为 `.agents/skills/gframework-batch-boot/SKILL.md` 与 `.agents/skills/README.md` 补齐数字速记 stop condition 语义。
|
||
- 明确 `$gframework-batch-boot 75` / `75 2000` 默认绑定 `origin/main` 累计 diff 口径。
|
||
- 完成第一批 landing / API 导航页 README 外链治理，并通过 `docs/` 站点构建。
|
||
|
||
### 归档指针
|
||
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-through-rp-007.md`
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-status-history-through-rp-016.md`
|
||
- `ai-plan/public/documentation-full-coverage-governance/archive/traces/documentation-full-coverage-governance-trace-history-through-rp-016.md`
|
||
|
||
### 下一步
|
||
|
||
1. 提交并推送本地修正后，再次抓取 PR `#272`，确认 Greptile open thread 是否已在新 head commit 上消失。
|
||
2. 若继续执行文档治理批处理，优先排查剩余的非导航型裸路径引用、标题锚点与站内链接热点，而不是扩成跨模块大波次。
|