mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
docs(zh-cn): 补齐文档元数据缺口
- 补齐 docs/zh-CN 多个栏目页面的 title 与 description frontmatter,清空完全缺 frontmatter 的历史页面 - 修复 multiplayer、source-generators 与 troubleshooting 触达页面暴露的 Markdown 结构和站内链接问题 - 更新 documentation-full-coverage-governance 的恢复点、验证结果与下一批 metadata 热点
This commit is contained in:
parent
5b7c555472
commit
982249151e
@ -12,11 +12,11 @@
|
||||
|
||||
## 当前恢复点
|
||||
|
||||
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-024`
|
||||
- 恢复点编号:`DOCUMENTATION-FULL-COVERAGE-GOV-RP-025`
|
||||
- 当前阶段:`Phase 5 - Governance Maintenance`
|
||||
- 当前焦点:
|
||||
- 保持 `README.md` 与 `docs/**` 公开页面只承载读者需要的采用信息,不再混入 XML inventory、覆盖基线、恢复点或治理批次说明
|
||||
- 继续按 `$gframework-batch-boot 75` 的 `origin/main` 分支 diff 阈值做小批量文档治理,优先处理低风险公开文案与导航热点
|
||||
- 继续按 `$gframework-batch-boot 75` 的 `origin/main` 分支 diff 阈值做小批量文档治理,优先处理低风险 metadata 缺口、坏链与 Markdown 结构问题
|
||||
- 保持 `Game` persistence docs surface 与当前 `README`、源码、`PersistenceTests` 使用同一套 owner / adoption path 叙述
|
||||
- 保持 `GFramework.Godot.SourceGenerators/README.md` 与 `docs/zh-CN/tutorials/godot-integration.md` 在生命周期接法上的一致性
|
||||
- 保持 active tracking / trace 只承载当前恢复入口,把阶段细节留在 `archive/`
|
||||
@ -84,6 +84,17 @@
|
||||
再次通过,仅保留既有大 chunk warning
|
||||
- 截至当前未提交工作树,`HEAD` 相对 `origin/main` 的累计 branch diff 仍为 `18` 个文件;新增待提交批次为 `21` 个文件、
|
||||
`126` changed lines,合并后仍显著低于 `$gframework-batch-boot 75` 的停止阈值。
|
||||
- `2026-04-24` 继续在同一 stop condition 下执行第三个低风险批次,集中清理 `docs/zh-CN` 其余“完全缺 frontmatter”的页面:
|
||||
- 已为 `best-practices/*.md` 中缺口页、`contributing.md`、`faq.md`、`game/config-system.md`、
|
||||
`getting-started/*.md`、`godot/coroutine.md`、6 个 `source-generators/*.md`、`troubleshooting.md`、
|
||||
`tutorials/advanced-patterns.md`、`tutorials/basic/index.md` 与 `tutorials/index.md` 补齐 frontmatter
|
||||
- 在同批次内修复 `best-practices/multiplayer.md` 的未闭合代码块、`source-generators/*.md` 中缺少 `.md`
|
||||
后缀的相对链接,以及 `troubleshooting.md` 里 3 处目录索引死链
|
||||
- 当前 `docs/zh-CN` 已不存在“完全缺 frontmatter”的页面;剩余 metadata 热点只剩
|
||||
`docs/zh-CN/index.md` 与 `docs/zh-CN/tutorials/basic/01-07.md` 共 `8` 个“已有 frontmatter 但缺 title /
|
||||
description”的页面
|
||||
- 本批次落地前,当前分支相对 `origin/main` 的累计 branch diff 为 `39` 个文件;连同本轮工作和 tracking / trace
|
||||
更新后,预计提交后累计 diff 约为 `63` 个文件,仍低于 `$gframework-batch-boot 75` 的停止阈值
|
||||
|
||||
## 当前风险
|
||||
|
||||
@ -126,6 +137,11 @@
|
||||
`core/state-management.md` 的 4 处站内坏链;剩余仅为既有代码块语言 warning,不影响任务级通过。
|
||||
- `2026-04-24` `bun run build`(工作目录:`docs/`,第二次)
|
||||
- 结果:通过;frontmatter 与坏链修复后站点仍可正常构建,仅保留既有大 chunk warning。
|
||||
- `2026-04-24` focused validator(逐个校验第三批触达的 `22` 个页面)
|
||||
- 结果:通过;frontmatter、真实坏链与未闭合代码块问题均已修复,剩余仅为 `best-practices/architecture-patterns.md`、
|
||||
`best-practices/index.md`、`contributing.md`、`troubleshooting.md` 与 `tutorials/index.md` 的既有代码块语言 warning。
|
||||
- `2026-04-24` `bun run build`(工作目录:`docs/`,第三次)
|
||||
- 结果:通过;第三批 frontmatter 与链接修复后站点仍可正常构建,仅保留既有大 chunk warning。
|
||||
- `2026-04-23` `python3 .agents/skills/gframework-pr-review/scripts/fetch_current_pr_review.py --format json --json-output /tmp/current-pr-review.json`
|
||||
- 结果:通过;PR `#272` 处于 `OPEN`,latest head commit 存在 1 条 Greptile open thread,定位到
|
||||
`docs/zh-CN/godot/setting.md:75` 的 inline code HTML entity 渲染问题。
|
||||
@ -146,7 +162,8 @@
|
||||
|
||||
## 下一步
|
||||
|
||||
1. 若继续执行 `$gframework-batch-boot 75`,优先改做代码块语言标记、少量残余坏链与其他栏目历史 frontmatter 缺口的分目录批次修复。
|
||||
1. 若继续执行 `$gframework-batch-boot 75`,优先处理 `docs/zh-CN/index.md` 与 `tutorials/basic/01-07.md` 这 `8`
|
||||
个“已有 frontmatter 但缺 `title` / `description`”的 metadata 缺口。
|
||||
2. 若后续继续扩展批处理 skill,可考虑再补充显式单位写法,例如 `75 files 2000 lines`,但当前默认速记已足够覆盖
|
||||
常见分支阈值场景。
|
||||
3. 若后续分支继续调整 `Game` persistence runtime、README 或公共 API,优先复核 `docs/zh-CN/game/data.md`、
|
||||
|
||||
@ -2,6 +2,48 @@
|
||||
|
||||
## 2026-04-24
|
||||
|
||||
### 当前恢复点:RP-025
|
||||
|
||||
- 继续沿用 `$gframework-batch-boot 75`,基线保持 `origin/main`(`2de57f5`,`2026-04-23T23:03:40+08:00`)。
|
||||
- 本轮目标从“继续治理公开文档边界”切换为“清空 `docs/zh-CN` 中仍然完全缺 frontmatter 的页面,同时把触达页暴露的真实格式错误一并收口”。
|
||||
- 本轮执行的修复:
|
||||
- 为 `best-practices`、`getting-started`、`source-generators`、`tutorials` 等目录下共 `22` 个页面补齐
|
||||
`title` / `description` frontmatter
|
||||
- 修复 `docs/zh-CN/best-practices/multiplayer.md` 末尾缺失的代码块闭合符
|
||||
- 修复 `docs/zh-CN/source-generators/*.md` 与 `docs/zh-CN/troubleshooting.md` 中一组缺少 `.md` 后缀或目录索引写法不兼容当前 validator 的站内链接
|
||||
|
||||
### 当前决策(RP-025)
|
||||
|
||||
- 对文档批处理,优先选择“元数据缺口 + 顺手修复真实结构错误”的组合,而不扩成正文语义刷新或大规模 code fence language 治理。
|
||||
- 当 focused validator 暴露的是触达页上的真实错误(如坏链、未闭合代码块)时,同批次直接收口;仅把纯 warning 留给下一轮专门治理。
|
||||
- 本轮结束时,`docs/zh-CN` 已没有“完全缺 frontmatter”的页面;下一批最稳定的切片是 `docs/zh-CN/index.md` 与
|
||||
`docs/zh-CN/tutorials/basic/01-07.md` 这 `8` 个“已有 frontmatter 但缺 `title` / `description`”的页面。
|
||||
- 当前已提交分支 diff 仍为 `39` 个文件;将本轮工作连同 tracking / trace 提交后,预计累计 branch diff 约为 `63`
|
||||
个文件,仍低于 `$gframework-batch-boot 75` 的停止阈值。
|
||||
|
||||
### 当前验证(RP-025)
|
||||
|
||||
- frontmatter 缺口巡检:
|
||||
- `for f in $(find docs/zh-CN -type f -name '*.md' | sort); do if ! head -n 5 "$f" | grep -q '^---$'; then echo "$f"; fi; done`
|
||||
- 结果:本轮前命中 `22` 个页面,当前已全部补齐。
|
||||
- focused validator:
|
||||
- 逐个校验本轮触达的 `22` 个页面
|
||||
- 结果:通过;只剩 `best-practices/architecture-patterns.md`、`best-practices/index.md`、`contributing.md`、
|
||||
`troubleshooting.md` 与 `tutorials/index.md` 的既有代码块语言 warning。
|
||||
- 站点构建:
|
||||
- `bun run build`(工作目录:`docs/`)
|
||||
- 结果:通过;仅保留既有大 chunk warning。
|
||||
- 后续候选扫描:
|
||||
- `python3 - <<'PY' ...`(扫描已有 frontmatter 但缺 `title` / `description` 的页面)
|
||||
- 结果:命中 `docs/zh-CN/index.md` 与 `docs/zh-CN/tutorials/basic/01-07.md` 共 `8` 个页面,可作为下一批 metadata 修复入口。
|
||||
|
||||
### 下一步
|
||||
|
||||
1. 继续执行 `$gframework-batch-boot 75` 时,优先补齐 `docs/zh-CN/index.md` 与 `tutorials/basic/01-07.md` 的
|
||||
`title` / `description` 缺口。
|
||||
2. 若仍有余量,再按目录收口 `best-practices`、`contributing`、`troubleshooting`、`tutorials/index.md`
|
||||
的代码块语言 warning,而不是跨全站混做。
|
||||
|
||||
### 当前恢复点:RP-024
|
||||
|
||||
- 根据用户反馈,将本轮目标重定义为“清理公开文档中的治理盘点式内容,并把同类约束补进仓库规范与 doc-refresh skill”。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 架构设计模式指南
|
||||
description: 围绕 GFramework 常见架构模式的职责划分、适用场景与组合建议。
|
||||
---
|
||||
|
||||
# 架构设计模式指南
|
||||
|
||||
> 全面介绍 GFramework 中的架构设计模式,帮助你构建清晰、可维护、可扩展的游戏架构。
|
||||
@ -3440,4 +3445,4 @@ public void GetPlayerStatsQuery_ShouldReturnCorrectStats()
|
||||
|
||||
**文档版本**: 2.0.0
|
||||
**最后更新**: 2026-03-07
|
||||
**作者**: GFramework Team
|
||||
**作者**: GFramework Team
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 错误处理最佳实践
|
||||
description: 总结 GFramework 项目中的错误建模、异常处理、日志记录与恢复策略。
|
||||
---
|
||||
|
||||
# 错误处理最佳实践
|
||||
|
||||
> 本指南介绍 GFramework 中的错误处理模式和最佳实践,帮助你构建健壮、可维护的游戏应用。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 最佳实践
|
||||
description: 汇总使用 GFramework 时的架构、性能、错误处理与多人游戏等实践建议。
|
||||
---
|
||||
|
||||
# 最佳实践
|
||||
|
||||
本文档总结了使用 GFramework 的最佳实践和设计模式。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 多人游戏架构指南
|
||||
description: 面向 GFramework 多人游戏项目的架构拆分、同步策略与网络优化建议。
|
||||
---
|
||||
|
||||
# 多人游戏架构指南
|
||||
|
||||
> 基于 GFramework 架构设计高性能、可扩展的多人游戏系统。
|
||||
@ -544,3 +549,4 @@ public class ClientPresentationSystem : AbstractSystem
|
||||
ShowKillFeed(e.KillerId, e.PlayerId);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 性能优化指南
|
||||
description: 整理 GFramework 项目在对象池、事件、协程与资源管理上的性能优化建议。
|
||||
---
|
||||
|
||||
# 性能优化指南
|
||||
|
||||
> 全面的性能优化策略和最佳实践,帮助你构建高性能的游戏应用。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 贡献指南
|
||||
description: 说明参与 GFramework 仓库贡献时的协作方式、提交流程与社区规范。
|
||||
---
|
||||
|
||||
# 贡献指南
|
||||
|
||||
欢迎为 GFramework 贡献代码!本指南将帮助你了解如何参与项目开发。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 常见问题(FAQ)
|
||||
description: 汇总 GFramework 在安装、架构、命令、事件与性能方面的常见问题。
|
||||
---
|
||||
|
||||
# 常见问题(FAQ)
|
||||
|
||||
## 安装与配置
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 游戏内容配置系统
|
||||
description: 说明 GFramework.Game 配置系统的定位、目录约定、生成能力与最小采用路径。
|
||||
---
|
||||
|
||||
# 游戏内容配置系统
|
||||
|
||||
> 面向静态游戏内容的 AI-First 配表方案
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 入门指南
|
||||
description: 概览 GFramework 的模块组成、最小接入路径与继续阅读入口。
|
||||
---
|
||||
|
||||
# 入门指南
|
||||
|
||||
这一部分只回答三个问题:
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 安装配置
|
||||
description: 说明 GFramework 各运行时与 source generator 包的安装选择和配置方式。
|
||||
---
|
||||
|
||||
# 安装配置
|
||||
|
||||
GFramework 提供多种安装方式,您可以根据项目需求选择合适的包进行安装。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 快速开始
|
||||
description: 通过只依赖 Core 的最小示例快速跑通 GFramework 基础架构。
|
||||
---
|
||||
|
||||
# 快速开始
|
||||
|
||||
本页给出一个只依赖 `Core` 的最小路径,用来确认你已经成功接入 `Architecture`、`Model`、`System` 与旧版命令执行器。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Godot 协程系统
|
||||
description: 说明 GFramework.Godot.Coroutine 的宿主集成能力、阶段语义与使用方式。
|
||||
---
|
||||
|
||||
# Godot 协程系统
|
||||
|
||||
## 概述
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: AutoRegisterModule 生成器
|
||||
description: 介绍 AutoRegisterModule 生成器如何为模块安装生成固定顺序的注册代码。
|
||||
---
|
||||
|
||||
# AutoRegisterModule 生成器
|
||||
|
||||
> 为架构模块生成固定顺序的组件注册代码,收敛 `Install(IArchitecture)` 样板。
|
||||
@ -149,5 +154,5 @@ partial class GameplayModule
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [源码生成器总览](./index)
|
||||
- [Context Get 注入生成器](./context-get-generator)
|
||||
- [源码生成器总览](./index.md)
|
||||
- [Context Get 注入生成器](./context-get-generator.md)
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: AutoScene 生成器
|
||||
description: 介绍 AutoScene 生成器如何生成场景包装入口与统一场景键声明。
|
||||
---
|
||||
|
||||
# AutoScene 生成器
|
||||
|
||||
> 为场景根节点生成 `GetScene()` 样板,统一场景键声明与行为包装。
|
||||
@ -116,5 +121,5 @@ partial class GameplayRoot
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [源码生成器总览](./index)
|
||||
- [AutoUiPage 生成器](./auto-ui-page-generator)
|
||||
- [源码生成器总览](./index.md)
|
||||
- [AutoUiPage 生成器](./auto-ui-page-generator.md)
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: AutoUiPage 生成器
|
||||
description: 介绍 AutoUiPage 生成器如何为 Godot UI 页面生成页面包装入口。
|
||||
---
|
||||
|
||||
# AutoUiPage 生成器
|
||||
|
||||
> 为 Godot UI 页面生成 `GetPage()` 样板,统一页面键与层级声明。
|
||||
@ -149,6 +154,6 @@ public partial class PauseMenu : Control
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [源码生成器总览](./index)
|
||||
- [GetNode 生成器](./get-node-generator)
|
||||
- [BindNodeSignal 生成器](./bind-node-signal-generator)
|
||||
- [源码生成器总览](./index.md)
|
||||
- [GetNode 生成器](./get-node-generator.md)
|
||||
- [BindNodeSignal 生成器](./bind-node-signal-generator.md)
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Context Get 注入生成器
|
||||
description: 介绍 Context Get 注入生成器的能力、依赖前提与使用方式。
|
||||
---
|
||||
|
||||
# Context Get 注入生成器
|
||||
|
||||
> 自动注入架构组件,消除样板代码
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 枚举扩展生成器
|
||||
description: 介绍枚举扩展生成器生成的 IsX 与 IsIn 方法及其典型用法。
|
||||
---
|
||||
|
||||
# 枚举扩展生成器
|
||||
|
||||
> 自动为枚举类型生成扩展方法
|
||||
@ -267,6 +272,6 @@ public class PlayerController
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Source Generators 概述](./index)
|
||||
- [日志生成器](./logging-generator)
|
||||
- [ContextAware 生成器](./context-aware-generator)
|
||||
- [Source Generators 概述](./index.md)
|
||||
- [日志生成器](./logging-generator.md)
|
||||
- [ContextAware 生成器](./context-aware-generator.md)
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 日志生成器
|
||||
description: 介绍日志生成器如何为标记类型生成 ILogger 字段并减少日志样板。
|
||||
---
|
||||
|
||||
# 日志生成器
|
||||
|
||||
> GFramework.Core.SourceGenerators 自动生成日志代码,减少样板代码
|
||||
@ -336,6 +341,6 @@ public static partial class StaticHelper
|
||||
|
||||
**相关文档**:
|
||||
|
||||
- [Source Generators 概述](./index)
|
||||
- [枚举扩展生成器](./enum-generator)
|
||||
- [ContextAware 生成器](./context-aware-generator)
|
||||
- [Source Generators 概述](./index.md)
|
||||
- [枚举扩展生成器](./enum-generator.md)
|
||||
- [ContextAware 生成器](./context-aware-generator.md)
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 故障排除与调试
|
||||
description: 提供 GFramework 常见安装、架构、事件与运行时问题的排查思路。
|
||||
---
|
||||
|
||||
# 故障排除与调试
|
||||
|
||||
本指南帮助你诊断和解决 GFramework 使用中的常见问题。
|
||||
@ -2047,11 +2052,11 @@ public class MyLoader : IResourceLoader
|
||||
|
||||
如果问题仍未解决:
|
||||
|
||||
1. 查看 [Core 文档](/zh-CN/core/) 了解更多细节
|
||||
1. 查看 [Core 文档](/zh-CN/core/index.md) 了解更多细节
|
||||
2. 查看 [架构组件](/zh-CN/core/architecture) 了解架构设计
|
||||
3. 查看 [Godot 集成](/zh-CN/godot/) 了解 Godot 特定问题
|
||||
3. 查看 [Godot 集成](/zh-CN/godot/index.md) 了解 Godot 特定问题
|
||||
4. 在 [GitHub Issues](https://github.com/GeWuYou/GFramework/issues) 提交问题
|
||||
5. 查看 [教程](/zh-CN/tutorials/) 中的示例代码
|
||||
5. 查看 [教程](/zh-CN/tutorials/index.md) 中的示例代码
|
||||
6. 查看 [常见问题](/zh-CN/faq) 获取快速答案
|
||||
|
||||
---
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 高级模式教程
|
||||
description: 通过高级模式示例说明 GFramework 中的复杂架构组织与扩展方式。
|
||||
---
|
||||
|
||||
# 高级模式教程
|
||||
|
||||
> 深入学习 GFramework 的高级特性和设计模式,构建更复杂和可维护的游戏系统。
|
||||
@ -1637,4 +1642,4 @@ public partial class NetworkController : Node, IController
|
||||
---
|
||||
|
||||
**教程版本**: 1.0.0
|
||||
**更新日期**: 2026-01-12
|
||||
**更新日期**: 2026-01-12
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 基础教程:从零开始使用 GFramework
|
||||
description: 从零开始串联环境准备、项目搭建与核心概念的基础教程入口。
|
||||
---
|
||||
|
||||
# 基础教程:从零开始使用 GFramework
|
||||
|
||||
欢迎来到 GFramework 的基础教程!本教程将带你从零开始,创建一个完整的计数器应用,逐步掌握 GFramework 的核心概念和最佳实践。
|
||||
|
||||
@ -1,3 +1,8 @@
|
||||
---
|
||||
title: 教程
|
||||
description: 汇总 GFramework 的基础与进阶教程入口,帮助按学习阶段选择阅读路径。
|
||||
---
|
||||
|
||||
# 教程
|
||||
|
||||
欢迎来到 GFramework 教程中心!这里提供从入门到精进的完整学习路径,帮助你掌握这个面向游戏开发的模块化 C# 框架。
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user