sqlopt-skills 项目知识库¶
本知识库由 MkDocs Material 驱动,源文件在 git 仓库
docs/docs/下。
两个分区¶
| 分区 | 用途 | 写入方式 |
|---|---|---|
| 当前状态 | 永远反映项目当前情况(活文档) | 单文件覆盖更新 |
| 知识库 | 按主题归类的经验沉淀 | 按主题增量追加 |
快速入口¶
工作流¶
issue / PR / 决策
↓
写到「当前状态」对应文件
↓
定期 review(双周)
↓
沉淀到「知识库」对应主题
编辑指南¶
- 修改任何 markdown 文件 → git commit → push
- 本地预览:
cd docs && mkdocs serve - 团队访问:浏览器打开部署后的静态站点