跳转到主要内容

在 GitHub 上编辑

  1. 打开页面,
  2. 点击编辑,
  3. 提交一个拉取请求。

本地文档工作流程

  1. 克隆仓库,
  2. 安装 Mintlify CLI (npm i -g mint),
  3. 运行 mint devdocs/,
  4. 使用 验证链接 mint broken-links,
  5. 打开拉取请求。

书写标准

  • 使用主动语态和第二人称,
  • 保持示例可执行,
  • 每页开头说明目标和先决条件,
  • 保持命令标志与当前CLI帮助输出保持一致。