跳转到主要内容

在 GitHub 上编辑

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

本地文档工作流

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

写作标准

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