Appearance
如何更新文档
新增页面
- 在
docs/srs/或docs/architecture/下新增 Markdown 文件,文件名使用数字前缀保证排序稳定,例如:08-xxx.md。 - 在
docs/.vitepress/config.js的 sidebar 中新增对应链接。 - 本地检查链接与标题是否正确。
修改现有页面
- 优先保持章节编号与侧边栏一致。
- 需求条目建议使用统一模板(功能描述/优先级/输入/操作序列/输出/补充说明)。
- 若修改涉及 Demo 口径或路线图:同步更新
docs/roadmap.md与docs/srs/07-acceptance.md。
进度与变更记录(必须)
- 每次代码更新(新增功能、修复 bug、调整接口)都必须在
docs/progress/00-status.md的“更新记录”新增一条。 - 建议写清:改了什么、影响哪个 Demo、如何验证、关联 commit。
编写约定
- 文档统一使用 UTF-8 编码。
- 尽量使用短句与列表,保持可读性。