mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-12 05:08:58 +08:00
1239fb4651
- 新增 gframework-doc-refresh 统一技能入口，并补齐模块扫描、证据顺序、模板与校验脚本 - 更新共享文档规范与模块映射，收口源码模块到 README、docs 和 ai-libs 的固定关联 - 删除旧 vitepress-* 公开技能定义，避免继续以文档类型拆分入口 - 同步 documentation-governance-and-refresh 的恢复点、风险和下一步
39 lines
823 B
Markdown
39 lines
823 B
Markdown
# Output Strategy
|
|
|
|
The module scan determines the document type.
|
|
|
|
Use this priority:
|
|
|
|
1. fix README / landing page / adoption path
|
|
2. fix stale topic pages
|
|
3. add or refresh API reference coverage
|
|
4. add or refresh tutorials
|
|
|
|
## Landing Page Checklist
|
|
|
|
- module purpose
|
|
- package relationship
|
|
- minimum adoption path
|
|
- real entry points
|
|
- next-reading links
|
|
|
|
## Topic Page Checklist
|
|
|
|
- current role
|
|
- public entry points
|
|
- minimum example
|
|
- compatibility or migration boundary
|
|
- related pages
|
|
|
|
## API Reference Checklist
|
|
|
|
- only for types or members that materially help consumers
|
|
- grounded in XML docs and source
|
|
- no speculative examples
|
|
|
|
## Tutorial Checklist
|
|
|
|
- only after the landing path is accurate
|
|
- keep the scenario traceable to source/tests or `ai-libs/`
|
|
- explain why each step exists, not just the code shape
|