跳到主要内容
版本：Current

贡献流程

适用对象​

  • 向 cssadoc 提交文档或配置改动的技术部成员

流程​

步骤​

1. 创建分支​

git checkout main
git pull
git checkout -b docs/your-topic

分支命名建议：docs/、fix/、chore/ 前缀 + 简短描述。

2. 修改内容​

  • 文档：编辑 docs/ 下 Markdown
  • 导航：同步更新 sidebars.ts
  • 站点配置：谨慎修改 docusaurus.config.ts，在 PR 中说明原因

3. 本地验证​

npm run build

确保构建成功。如有 TypeScript 改动：

npm run typecheck

4. 提交 PR​

  • 标题简明描述改动（如「docs(cssagpt): 补充 Docker 部署步骤」）
  • 正文说明改了什么、为什么改
  • 关联相关 issue（如有）

5. Review 与合并​

至少一名熟悉该系统的成员 review。合并后由有 Cloudflare 权限的维护者执行部署（或依赖 CI 自动部署）。

文档 Review 要点​

  • 适用对象与目的是否清晰
  • 操作步骤可复现
  • 新页面已加入 sidebar
  • 术语与 术语表 一致
  • 无密钥、内网 IP 等敏感信息
  • Mermaid 图表可正常渲染

发布文档新版本​

当需要冻结当前文档为 V1 并开启新 major 版本时：

  1. 使用 Docusaurus versioning 命令或手动维护 versioned_docs/
  2. 更新 versions.json
  3. 在 PR 中说明版本策略变更

详见 Docusaurus versioning 文档。

风险提示​

⚠️ 不要在文档中提交 API Key、数据库密码、SSH 私钥等敏感信息。示例配置使用占位符如 YOUR_API_KEY。