你的更改如何发布取决于你当前所在的分支:
  • 部署分支:发布会立即更新你的线上站点。
  • 其他分支:发布会创建一个 Pull Request,便于你在部署到生产环境之前审查更改。
在 Mintlify 网页编辑器中突出显示的发布按钮

Pull requests 与变更审查

Pull requests 允许你从自己的分支发起变更,以便在合并到线上文档之前让其他人进行审核。这有助于确保你的修改准确无误,并为团队提供协作完善内容的机会。
即使独自工作,pull requests 也有助于预览变更并维护清晰的更新历史。

创建拉取请求

1

保存你的工作

确保已使用 Save Changes 将所有更改保存到你的分支。
2

创建拉取请求

在编辑器右上角选择 Publish Pull Request
3

添加标题和描述

编写清晰的标题和描述,说明:
  • 你做了哪些更改
  • 你为什么进行这些更改
  • 任何需要重点评审的部分
4

创建并分享

选择 Publish Pull Request。编辑器会提供一个链接用于查看你的拉取请求。
Mintlify 网页编辑器中突出显示的 Publish Pull Request 按钮

审查 pull request

创建 pull request 后:
  1. 审查变更:你和团队成员可以在 Git 提供商(如 GitHub 或 GitLab)中审查该 pull request。
  2. 留下反馈:添加评论或请求修改。
  3. 继续修改:在网页编辑器中进行进一步修改。保存后,编辑器会将更改推送到你的 pull request。
  4. 批准:对变更满意时,批准该 pull request。
  5. 合并:准备将变更部署到生产环境时,合并该 pull request。