Delete a large set of outdated documentation (many files under docs/ and .hermes/plans/, including audits, design, prd, technical, planning, assets, and todos). Update and consolidate .hermes content: refresh shared-memory pages (decision-log, development-workflow, document-map, pitfalls, project-overview, team-conventions) and several skills/references under .hermes/skills. Also modify AGENTS.md, README.md, UI_CODING_STANDARD.md, docs/README.md and .encoding-check-ignore. Purpose: clean up stale planning/audit material and keep current hermes documentation and related top-level docs in sync.
2.2 KiB
2.2 KiB
文档地图与阅读索引
更新时间:2026-05-15
当前文档入口
| 场景 | 优先阅读 |
|---|---|
| 建立项目背景 | README.md、AGENTS.md、.hermes/shared-memory/project-overview.md |
| 找当前文档 | docs/README.md |
| 产品、命名、UI、协作和废弃路线 | docs/【项目基线】当前产品与工程约束-2026-05-15.md |
| 后端、DDD、API、SpacetimeDB schema 和表目录 | docs/【后端架构】server-rs与SpacetimeDB数据契约-2026-05-15.md |
| 创作入口、草稿架和玩法链路 | docs/【玩法创作】平台入口与玩法链路-2026-05-15.md |
| 本地启动、验证、部署、埋点和运营查询 | docs/【开发运维】本地开发验证与生产运维-2026-05-15.md |
| UI 像素资产与 9-slice 规范 | UI_CODING_STANDARD.md |
阅读顺序
通用复杂任务:
AGENTS.md.hermes/shared-memory/docs/README.md- 与任务匹配的当前融合文档
后端 / 数据真相 / SpacetimeDB:
docs/【后端架构】server-rs与SpacetimeDB数据契约-2026-05-15.mddocs/【开发运维】本地开发验证与生产运维-2026-05-15.md- 对应 crate README 或源码
玩法 / 创作入口 / 运行态:
docs/【玩法创作】平台入口与玩法链路-2026-05-15.mddocs/【项目基线】当前产品与工程约束-2026-05-15.md- 相关前端组件、service、shared contract 和后端 module
生产部署 / 服务器 / Jenkins:
docs/【开发运维】本地开发验证与生产运维-2026-05-15.mddeploy/env/api-server.env.exampledeploy/nginx/README.md
维护规则
- 当前
docs/只保留少量融合文档。 - 新增工程实现时,如果已有对应当前文档,必须同步更新。
- 如果没有合适位置,新文档文件名必须使用
【标签名】中文标题-YYYY-MM-DD.md。 - 阶段性流水账、一次性修复记录和已关闭实验不要再新增为长期文档。
- 阶段性计划和一次性 TODO 不再作为长期文档目录;需要保留的决策、流程和坑点应进入
docs/当前文档或.hermes/shared-memory/。 - 如果文档与代码冲突,先确认代码事实,再更新过期文档和共享记忆。