> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# 在 Web 编辑器中协作

> 使用 branch、拉取请求和预览部署协作撰写文档。

使用基于 branch 的工作流、拉取请求和预览部署，与团队协作撰写文档。

如果你不熟悉 Git，请参阅 [Git 概念](/zh/guides/git-concepts)。

<div id="branch-based-collaboration">
  ## 基于 branch 的协作
</div>

使用 branch 并行更新文档，在不影响线上站点的前提下完成修改。

<div id="why-use-branches">
  ### 为什么要使用 branch
</div>

* **隔离更改**：在不影响线上文档的情况下进行更新。
* **发布前评审**：在更改上线之前先获取团队成员的反馈。
* **并行协作**：多个团队成员可以同时在不同的 branch 上工作。

<div id="recommended-workflow">
  ### 推荐工作流
</div>

1. 为你的更改创建一个 feature branch。
2. 在该 branch 上进行修改并保存。
3. 在准备好接受审核时创建一个拉取请求（PR；亦称“合并请求”/Merge Request）。
4. 处理反馈并更新该 branch。
5. 在拉取请求获批后合并。

此工作流可确保更改在上线前经过审核，并保持清晰的更新历史记录。

<div id="pull-request-workflow">
  ## 拉取请求工作流
</div>

拉取请求（PR；亦称“合并请求”/Merge Request）让你可以在合并到线上文档之前，先提出更改并与团队协作。

<Steps>
  <Step title="创建拉取请求">
    当你准备好发布更改时，可以在编辑器中创建拉取请求。有关使用拉取请求的更多信息，请参阅 <a href="/zh/editor/publish">在网页编辑器中发布更改</a>。
  </Step>

  <Step title="审查拉取请求">
    在你的 Git 托管平台（如 GitHub 或 GitLab）中审查拉取请求。
  </Step>

  <Step title="回应反馈">
    当审查者请求更改时，根据要求进行修改并保存你的更改。这些更改会自动推送到现有的拉取请求中。
  </Step>

  <Step title="合并拉取请求">
    当所有请求的更改都已处理、拉取请求已通过必需审查者批准且所有自动检查均已通过时，合并你的拉取请求。
  </Step>
</Steps>

<div id="preview-deployments">
  ## 预览部署
</div>

预览部署会创建临时 URL，你可以在更改正式上线之前先查看效果。

<Steps>
  <Step title="访问预览部署">
    * 在编辑器工具栏中点击 **Share**。
    * 点击 **Preview**，在新标签页中打开预览部署。
    * 预览 URL 会展示应用了你所有已保存更改后的文档站点。
  </Step>

  <Step title="分享预览">
    将预览部署的 URL 分享给团队成员以收集反馈。当你保存更多更改时，预览会自动更新。
  </Step>

  <Step title="预览认证">
    预览 URL 默认对所有人公开可访问。在控制台的 [附加组件（Add-ons）](https://dashboard.mintlify.com/products/addons) 页面启用预览认证，以将访问限制为已通过认证的组织成员。
  </Step>
</Steps>