mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-06 16:16:44 +08:00
docs(godot): 修正 README 示例命名空间
- 修正 GFramework.Godot.SourceGenerators README 中错误的 SourceGenerators 特性命名空间示例 - 更新 documentation-full-coverage-governance 的 tracking 与 trace,记录 PR #272 的 Greptile follow-up 和验证结果
This commit is contained in:
parent
a6b87c23e4
commit
c3085f7c6a
@ -132,7 +132,7 @@
|
||||
最小接法可以直接写成:
|
||||
|
||||
```csharp
|
||||
using GFramework.Godot.Attribute;
|
||||
using GFramework.Godot.SourceGenerators.Abstractions;
|
||||
using Godot;
|
||||
|
||||
public partial class MainMenu : Control
|
||||
|
||||
@ -12,7 +12,7 @@
|
||||
|
||||
## 当前恢复点
|
||||
|
||||
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-017`
|
||||
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-018`
|
||||
- 当前阶段:`Phase 5 - Governance Maintenance`
|
||||
- 当前焦点:
|
||||
- 保持 `Game` persistence docs surface 与当前 `README`、源码、`PersistenceTests` 使用同一套 owner / adoption path 叙述
|
||||
@ -31,7 +31,13 @@
|
||||
- 为 `docs/zh-CN/game/data.md` 补充 `UnifiedSettingsDataRepository` 的统一文件布局示例
|
||||
- 为 `GFramework.Godot.SourceGenerators/README.md` 补充手写 `_Ready()` / `_ExitTree()` 时显式调用生成方法的最小样例
|
||||
- 将过长的 active tracking / trace 瘦身,并把历史摘要迁回 `archive/`
|
||||
- 当前唯一剩余的 PR 信号是 GitHub `Title check` 对 PR 标题过泛的 inconclusive 提示;这属于托管侧元数据,不是本地文件缺陷。
|
||||
- `2026-04-23` 使用 `$gframework-pr-review` 重新抓取 PR `#272` 后,确认最新 latest-head review 里仍有 1 条
|
||||
Greptile open thread,指出 `GFramework.Godot.SourceGenerators/README.md` 的最小样例误写成
|
||||
`using GFramework.Godot.Attribute;`。
|
||||
- 该命名空间错误已在本地修正为 `using GFramework.Godot.SourceGenerators.Abstractions;`,待提交并推送后再回到
|
||||
GitHub 侧确认 open thread 是否消失。
|
||||
- 当前剩余的托管侧信号是 GitHub `Title check` 对 PR 标题过泛的 inconclusive 提示;这属于 PR 元数据,不是本地
|
||||
文件缺陷。
|
||||
|
||||
## 当前风险
|
||||
|
||||
@ -51,21 +57,22 @@
|
||||
|
||||
## 最新验证
|
||||
|
||||
- `2026-04-23` `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/gframework-current-pr-review.json`
|
||||
- 结果:通过;PR `#272` 处于 `OPEN`,latest head commit 没有未解决 open thread,当前只剩 `Title check` 的 PR 标题提示。
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/game/data.md`
|
||||
- 结果:通过。
|
||||
- `2026-04-23` `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/current-pr-review.json`
|
||||
- 结果:通过;PR `#272` 处于 `OPEN`,latest head commit 存在 1 条 Greptile open thread,定位到
|
||||
`GFramework.Godot.SourceGenerators/README.md:135` 的错误命名空间引用。
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-links.sh GFramework.Godot.SourceGenerators/README.md`
|
||||
- 结果:通过。
|
||||
- `2026-04-23` `bash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh GFramework.Godot.SourceGenerators/README.md`
|
||||
- 结果:通过。
|
||||
- `2026-04-23` `cd docs && bun run build`
|
||||
- `2026-04-23` `bun run build`(工作目录:`docs/`)
|
||||
- 结果:通过;仅保留既有 VitePress 大 chunk warning,无构建失败。
|
||||
|
||||
## 下一步
|
||||
|
||||
1. 如果 PR `#272` 的 `Title check` 仍需要消除,到 GitHub 上把标题改成更具体的文档治理描述。
|
||||
2. 若后续分支继续调整 `Game` persistence runtime、README 或公共 API,优先复核 `docs/zh-CN/game/data.md`、
|
||||
1. 提交并推送本地对 `GFramework.Godot.SourceGenerators/README.md` 的命名空间修正,然后重新抓取 PR `#272`
|
||||
确认 Greptile open thread 是否消失。
|
||||
2. 如果 PR `#272` 的 `Title check` 仍需要消除,到 GitHub 上把标题改成更具体的文档治理描述。
|
||||
3. 若后续分支继续调整 `Game` persistence runtime、README 或公共 API,优先复核 `docs/zh-CN/game/data.md`、
|
||||
`storage.md`、`serialization.md`、`setting.md` 与 landing page 是否仍保持同一套职责边界。
|
||||
3. 若后续分支继续调整 `Godot` generator 接法,优先复核 `GFramework.Godot.SourceGenerators/README.md`、
|
||||
4. 若后续分支继续调整 `Godot` generator 接法,优先复核 `GFramework.Godot.SourceGenerators/README.md`、
|
||||
`docs/zh-CN/tutorials/godot-integration.md` 与相关专题页是否仍保持一致。
|
||||
|
||||
@ -2,41 +2,47 @@
|
||||
|
||||
## 2026-04-23
|
||||
|
||||
### 当前恢复点:RP-017
|
||||
### 当前恢复点:RP-018
|
||||
|
||||
- 使用 `$gframework-pr-review` 复核当前分支 PR `#272`。
|
||||
- 本地核对后确认三条 review follow-up 仍然成立:
|
||||
- active tracking / trace 过长,已经偏离“恢复入口”用途
|
||||
- `docs/zh-CN/game/data.md` 缺少 `UnifiedSettingsDataRepository` 的统一文件布局示例
|
||||
- `GFramework.Godot.SourceGenerators/README.md` 缺少手写 `_Ready()` / `_ExitTree()` 时显式调用生成方法的最小样例
|
||||
- 使用 `$gframework-pr-review` 重新复核当前分支 PR `#272`。
|
||||
- GitHub latest-head review 当前暴露 1 条新的 Greptile open thread:
|
||||
`GFramework.Godot.SourceGenerators/README.md:135` 把示例命名空间写成了不存在的
|
||||
`GFramework.Godot.Attribute`。
|
||||
- 本地核对源码与现有文档后,确认 `[GetNode]` / `[BindNodeSignal]` 应来自
|
||||
`GFramework.Godot.SourceGenerators.Abstractions`,该评论成立。
|
||||
- 本轮执行的修复:
|
||||
- 为 `docs/zh-CN/game/data.md` 补充统一设置文件目录树示例
|
||||
- 为 `GFramework.Godot.SourceGenerators/README.md` 补充最小生命周期代码片段
|
||||
- 将 active tracking / trace 瘦身,并把 `RP-001` 到 `RP-016` 的阶段细节迁入 `archive/`
|
||||
- 将 `GFramework.Godot.SourceGenerators/README.md` 的示例 using 改为
|
||||
`GFramework.Godot.SourceGenerators.Abstractions`
|
||||
- 同步更新 active tracking / trace,记录该 PR review follow-up 与新的恢复点
|
||||
|
||||
### 当前决策(RP-017)
|
||||
### 当前决策(RP-018)
|
||||
|
||||
- active recovery artifact 只保留当前恢复点、当前事实、风险、验证结果与下一步;旧阶段细节统一转移到 archive。
|
||||
- `Game` persistence docs surface 继续以 `data.md`、`storage.md`、`serialization.md`、`setting.md` 作为最小巡检集合。
|
||||
- `GFramework.Godot.SourceGenerators/README.md` 的生命周期接法说明应直接复用与 tutorial 一致的最小样例,避免 README 与教程再次分叉。
|
||||
- PR review 结果以 GitHub latest-head open threads 为准;即便 active tracking 曾记录“无 open thread”,也必须按新抓取结果回写。
|
||||
- 对 `GFramework.Godot.SourceGenerators/README.md` 这类模块 README,最小代码样例的命名空间必须与源码中的
|
||||
`Abstractions` 包保持一致,不能沿用历史别名或猜测命名。
|
||||
- 当前本地修复完成后,下一次 GitHub 侧复核需要基于新提交/新 head commit,而不是旧的 PR review 快照。
|
||||
|
||||
### 当前验证(RP-017)
|
||||
### 当前验证(RP-018)
|
||||
|
||||
- PR review 抓取:
|
||||
- `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/gframework-current-pr-review.json`
|
||||
- 结果:通过;PR `#272` 处于 `OPEN`,latest head commit 没有未解决 open thread,当前只剩 `Title check` 的 PR 标题提示。
|
||||
- 文档校验:
|
||||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-all.sh docs/zh-CN/game/data.md`
|
||||
- 结果:通过。
|
||||
- `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --json-output /tmp/current-pr-review.json`
|
||||
- 结果:通过;PR `#272` 处于 `OPEN`,latest head commit 存在 1 条 Greptile open thread,定位到
|
||||
`GFramework.Godot.SourceGenerators/README.md:135` 的错误命名空间引用。
|
||||
- README 校验:
|
||||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-links.sh GFramework.Godot.SourceGenerators/README.md`
|
||||
- 结果:通过。
|
||||
- `bash .agents/skills/gframework-doc-refresh/scripts/validate-code-blocks.sh GFramework.Godot.SourceGenerators/README.md`
|
||||
- 结果:通过。
|
||||
- 构建校验:
|
||||
- `cd docs && bun run build`
|
||||
- `bun run build`(工作目录:`docs/`)
|
||||
- 结果:通过;仅保留既有 VitePress 大 chunk warning,无构建失败。
|
||||
|
||||
### 归档摘要(RP-017)
|
||||
|
||||
- active recovery artifact 只保留当前恢复点、当前事实、风险、验证结果与下一步;旧阶段细节统一转移到 archive。
|
||||
- `Game` persistence docs surface 继续以 `data.md`、`storage.md`、`serialization.md`、`setting.md` 作为最小巡检集合。
|
||||
- `GFramework.Godot.SourceGenerators/README.md` 的生命周期接法说明应直接复用与 tutorial 一致的最小样例,避免 README 与教程再次分叉。
|
||||
|
||||
### 归档指针
|
||||
|
||||
- `ai-plan/public/documentation-full-coverage-governance/archive/todos/documentation-full-coverage-governance-validation-history-through-rp-007.md`
|
||||
@ -45,8 +51,5 @@
|
||||
|
||||
### 下一步
|
||||
|
||||
1. 如果 PR `#272` 的 `Title check` 仍需要处理,到 GitHub 上把标题改成更具体的文档治理描述。
|
||||
2. 若后续分支继续调整 `Game` persistence runtime 或 README,优先复核 `docs/zh-CN/game/data.md`、
|
||||
`storage.md`、`serialization.md`、`setting.md` 与 landing page 是否仍保持一致。
|
||||
3. 若后续分支继续调整 `Godot` generator 接法,优先复核 `GFramework.Godot.SourceGenerators/README.md`、
|
||||
`docs/zh-CN/tutorials/godot-integration.md` 与相关专题页是否仍保持一致。
|
||||
1. 提交并推送本地修正后,再次抓取 PR `#272`,确认 Greptile open thread 是否已在新 head commit 上消失。
|
||||
2. 如果 PR `#272` 的 `Title check` 仍需要处理,到 GitHub 上把标题改成更具体的文档治理描述。
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user