项目文档

本页是传习社各项目文档的入口。第一版仅说明这里的组织方式，暂未收录具体项目。

这里放什么

每个项目一个独立章节，通常包含：

• 项目说明 — 这个项目解决什么问题，面向谁；
• 使用方式 — 如何获取、安装、运行；
• 开发说明 — 本地开发环境、构建与测试方式；
• 相关链接 — 代码仓库、Issue 跟踪地址。

目录规划

随着项目增多，本站会按下面的方式扩展：

项目文档
├── 项目 A
├── 项目 B
└── 项目 C

每个项目占据导航栏中的一个独立章节，与 GitLab、开发规范等章节并列，互不影响。

项目在哪里

在当前项目文档建立之前，请直接访问 GitLab 查看仓库与说明：

https://git.cx-studio.tech

新增项目文档

为某个项目建立文档章节时：

1. 在 docs/projects/ 下创建以项目名命名的目录；
2. 添加 index.md 作为章节首页；
3. 在 mkdocs.yml 的 nav 中登记该章节；
4. 通过 Merge Request 提交，按 开发规范 命名分支与 commit。

不必一次写全

先写清「这个项目是什么、怎么跑起来」，其余内容随项目推进逐步补充。空白页面不如没有页面。