mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-06 16:16:44 +08:00
- 更新 documentation governance 的 active tracking 与 trace,只保留当前恢复点、风险、验证结果与归档指针 - 归档 RP-001 到 RP-016 的状态与时间线摘要,降低 boot 恢复时的噪音 - 补充 UnifiedSettingsDataRepository 的统一文件布局示例,并补齐 Godot SourceGenerators 的生命周期接法代码片段
4.8 KiB
4.8 KiB
Documentation Full Coverage Governance Status History Through RP-016
以下内容从 active tracking 中迁出,用于保留 DOCUMENTATION-FULL-COVERAGE-GOV-RP-001 到
DOCUMENTATION-FULL-COVERAGE-GOV-RP-016 的阶段性状态、治理结论与恢复背景。默认 boot 只需要读取 active
tracking 中的最新摘要;若需要追溯已完成波次的详细背景,再回到本归档文件。
阶段里程碑
RP-001 到 RP-007
- 建立长期 active topic
documentation-full-coverage-governance,并在ai-plan/public/README.md中将当前分支docs/sdk-update-documentation映射到该 topic。 - 明确消费属性边界:
GFramework.Ecs.Arch.Abstractions是可打包直接消费模块,需要 README 与文档入口。GFramework.Core.SourceGenerators.Abstractions、GFramework.Godot.SourceGenerators.Abstractions、GFramework.SourceGenerators.Common都按IsPackable=false的内部支撑模块处理。
- 收口
Core/Core.AbstractionsREADME、landing page 与类型族级 XML inventory。 - 收口
Ecs.Arch/Ecs.Arch.AbstractionsREADME、landing page、抽象页与UseArch(...)早于Initialize()的采用约束。 - 收口
Cqrsfamily 的 runtime / abstractions / source generator 入口,并为缺失的内部类型补齐 XML 注释。 - 收口
Gamefamily 的 README、landing page、抽象页与类型族级 XML inventory。 - 将
Gamefamily 从“文档存在但入口失真”推进到“runtime / abstractions / source generator 都有当前可审计入口”。
RP-008 到 RP-013
- 消化 PR #271 的文档 follow-up,修正
gframework-pr-review脚本与 skill 中的 WSL Git 策略,使其与AGENTS.md保持一致。 - 将
Godotfamily 的核心恢复摘要迁回 active topic,避免默认恢复路径继续依赖 archive 细节。 - 重写
GFramework.Godot/README.md与GFramework.Godot.SourceGenerators/README.md,补齐当前包关系、 子系统地图、最小接入路径与站内文档入口。 - 更新根
README.md、docs/zh-CN/source-generators/index.md、docs/zh-CN/api-reference/index.md,把GFramework.Godot.SourceGenerators的 owner 与能力边界收敛到当前源码口径。 - 完成
Godotdocs surface 的 validation-only 巡检,确认 landing、tutorial、API reference 与 README 当前保持一致叙述,没有出现新的入口漂移。
RP-014 到 RP-016
- 重写
docs/zh-CN/godot/storage.md,补齐 frontmatter、GodotFileStorage的路径语义、repository 分工与GodotYamlConfigLoader分流边界。 - 重写
docs/zh-CN/godot/setting.md,改回当前ISettingsModel/RegisterApplicator(...)口径,并补齐LocalizationMapfallback 与当前 consumer wiring。 - 对
Godotdocs surface 再做一轮 validation-only 巡检,确认storage.md、setting.md、landing、README、 tutorial 与 API reference 没有新的回漂。 - 重写
docs/zh-CN/game/data.md、storage.md、serialization.md、setting.md,把Gamepersistence docs surface 收口到当前 repository / storage / serializer / settings 责任边界。 - 将
DataRepository、UnifiedSettingsDataRepository、SaveRepository<TSaveData>与FileStorage/ScopedStorage/SettingsModel<TRepository>的分工,统一回写到 README、源码与PersistenceTests已验证的采用路径。
已确认的长期事实
- 已归档的
documentation-governance-and-refresh只作为历史证据保留,不再作为默认boot入口。 Godotfamily 当前核心页面集包括:docs/zh-CN/godot/index.mddocs/zh-CN/godot/architecture.mddocs/zh-CN/godot/scene.mddocs/zh-CN/godot/ui.mddocs/zh-CN/godot/storage.mddocs/zh-CN/godot/setting.mddocs/zh-CN/godot/signal.mddocs/zh-CN/godot/extensions.mddocs/zh-CN/godot/logging.mddocs/zh-CN/tutorials/godot-integration.md
Gamepersistence docs surface 当前最值得优先复核的页面集包括:docs/zh-CN/game/data.mddocs/zh-CN/game/storage.mddocs/zh-CN/game/serialization.mddocs/zh-CN/game/setting.md
GFramework.Cqrs在当前 WSL / dotnet 环境下仍会读取失效的 fallback package folder,并在标准 build 中触发MSB4276/MSB4018;这是已知环境阻塞,不是本 topic 当前文档回归。- 当前 WSL 会话里
git.exe可解析但不可执行,仓库默认 Git 策略应继续优先使用显式--git-dir/--work-tree绑定。
关联归档
- 早期详细验证历史:
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/traces/documentation-full-coverage-governance-trace-history-through-rp-016.md