跳转到内容

文档编写与发布流程

  1. 新建分支并新增文档。
  2. 本地运行 npm run dev 进行预览。
  3. 执行 npm run build 确认构建通过。
  4. 提交 PR,至少 1 人 review。
  5. 合并后由托管平台自动发布。

每篇文档建议包含以下段落:

  • 背景
  • 方案
  • 风险
  • 回滚
  • 验证
  • 标题层级不超过 4 层
  • 所有命令可执行
  • 对外链接可访问
  • 发布前必须更新 release-notes