跳转到主要内容
更改的发布方式取决于你正在使用的分支:
  • 部署分支:发布会立即更新你的线上站点。
  • 其他分支:发布会创建一个拉取请求,便于你在部署到生产环境之前审核更改。
在 Mintlify 网页编辑器中突出显示的发布按钮

Pull Request 与变更审查

Pull Request 允许你从自己的分支发起更改,在合并到线上文档之前由他人进行审查。这样可以确保更改的准确性,并为团队提供协作完善内容的机会。
即使你独自作业,Pull Request 也有助于预览更改并维护清晰的更新历史。

创建拉取请求

1

保存你的工作

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

创建拉取请求

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

添加标题和描述

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

创建并分享

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

审查拉取请求

创建拉取请求后:
  1. 审查更改:你和团队成员可以在 GitHub、GitLab 等代码托管平台中审查该拉取请求。
  2. 留下反馈:添加评论或提出修改建议。
  3. 进一步修改:在网页编辑器中继续修改。保存后,编辑器会将变更推送到你的拉取请求。
  4. 批准:当你对变更满意时,批准该拉取请求。
  5. 合并:准备将变更部署到生产环境时,合并该拉取请求。