52 lines
2.6 KiB
JSON
52 lines
2.6 KiB
JSON
{
|
||
"module": "docs",
|
||
"version": "1.0",
|
||
"purpose": "MoFin 文档体系入口。开源项目式帮助文档：README 封面 + 完整目录 + 版本变更说明。让研发者和运营者（知微）都能通过文档了解系统全貌和最新变化。",
|
||
|
||
"human_help": {
|
||
"title": "📚 文档中心 — 系统帮助与版本变更",
|
||
"description": [
|
||
"MoFin 文档体系采用开源项目标准组织：README 封面导航 + 完整目录树 + 大版本变更说明。",
|
||
"研发者（小小莫/知微）通过文档理解系统各模块；运营者（知微）通过版本变更说明掌握每次大改动的内容和影响。",
|
||
"所有文档存放在 docs/ 目录，按主题分类。"
|
||
],
|
||
"usage": [
|
||
"打开 Dashboard 的「📚 文档」Tab，浏览文档目录",
|
||
"左侧目录树选择文档，右侧查看内容",
|
||
"「版本变更」页签查看每个大版本的改动说明（v1.0 初始架构、v2.0 JSON→DB、v3.0 策略体系、v4.0 自成长、v5.0 纯DB、v6.0 Cron 架构重构）",
|
||
"「版本变更」让知微知道每次大改动做了什么、影响什么"
|
||
],
|
||
"troubleshooting": [
|
||
"文档加载失败 → 检查 docs/ 目录权限和 md 文件存在性",
|
||
"版本变更空白 → 检查 docs/CHANGELOG-VERSIONS.md 是否存在",
|
||
"找不到某文档 → 查看 INDEX.md 完整目录"
|
||
]
|
||
},
|
||
|
||
"ai_spec": {
|
||
"apis": [
|
||
{"method": "GET", "path": "/api/docs/index", "returns": "{ok, index:[{path, title, category}]} — 文档目录树"},
|
||
{"method": "GET", "path": "/api/docs/versions", "returns": "{ok, versions:[{version, date, title, summary}]} — 版本变更列表"},
|
||
{"method": "GET", "path": "/api/docs/read?path=<path>", "returns": "{ok, content} — 读取指定文档内容（markdown）"}
|
||
],
|
||
"constraints": [
|
||
"所有文档必须放在 docs/ 目录，不允许散落",
|
||
"每个大版本必须写入 CHANGELOG-VERSIONS.md",
|
||
"README.md 是入口封面，必须保持最新导航",
|
||
"INDEX.md 是完整目录树，必须反映实际文档结构"
|
||
],
|
||
"dependencies": [
|
||
"docs/ 目录（文档源）",
|
||
"CHANGELOG-VERSIONS.md（版本变更源）",
|
||
"INDEX.md（目录树源）"
|
||
],
|
||
"file_layout": {
|
||
"docs/README.md": "文档中心封面（导航入口）",
|
||
"docs/INDEX.md": "完整文档目录树（按主题分类）",
|
||
"docs/CHANGELOG-VERSIONS.md": "大版本变更说明（v1.0/v2.0/.../v6.0）",
|
||
"docs/GUIDE.md": "系统全貌指南（给研发者的详细说明）",
|
||
"docs/<topic>/*.md": "按主题组织的文档"
|
||
}
|
||
}
|
||
}
|