mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
3ca550b188
* docs: update hosted docs domain to mintlify.site * docs: complete mintlify.site migration across remaining pages Updates 45 files that PR 6282 had originally changed but were reverted by PR 6285 and not re-addressed in this PR: - snippets/vercel-json-generator.mdx (all 4 locales): rewrite destinations now use mintlify.site, consistent with deploy/vercel.mdx - assistant/use.mdx: example deep-link URLs - ai/skillmd.mdx: agent card subdomain reference - guides/assistant-embed.mdx: docsURL code example - guides/codex.mdx: MCP URL example - deploy/authentication-setup.mdx: example Mintlify subdomain - discovery-openapi.json: domain identifier URL descriptions (4 occurrences) - integrations/privacy/osano.mdx: managed rule domain - editor/branching-and-publishing.mdx: branch preview URL format - customize/themes.mdx: theme demo site links - guides/help-center.mdx: live example link - zh/editor/collaborate.mdx: branch preview URL format All changes mirrored across es, fr, and zh locales. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
126 lines
5.5 KiB
Plaintext
126 lines
5.5 KiB
Plaintext
---
|
||
title: "在 Web 编辑器中协作"
|
||
sidebarTitle: "协作"
|
||
description: "通过实时协作、实时光标、可分享的编辑器链接、branch 以及拉取请求审查工作流，与团队一起编辑文档。"
|
||
keywords: ["编辑器", "协作", "实时", "实时编辑", "branch", "拉取请求", "预览部署", "可分享链接"]
|
||
---
|
||
|
||
通过实时编辑和基于 branch 的工作流，与团队协作撰写文档。
|
||
|
||
<div id="real-time-collaboration">
|
||
## 实时协作
|
||
</div>
|
||
|
||
多人可以同时编辑同一个页面。每个人所做的更改都会显示给页面上的所有其他人。
|
||
|
||
要在某个页面上进行实时协作，请将该页面的编辑器链接分享给你的队友。请参阅下方的 [分享编辑器链接](#share-editor-links)。
|
||
|
||
<Frame>
|
||
<img src="/images/editor/editor-light.png" className="block dark:hidden" alt="Web 编辑器展示多个光标的实时协作" />
|
||
<img src="/images/editor/editor-dark.png" className="hidden dark:block" alt="Web 编辑器展示多个光标的实时协作" />
|
||
</Frame>
|
||
|
||
<div id="how-real-time-editing-works">
|
||
### 实时编辑的工作原理
|
||
</div>
|
||
|
||
当多个团队成员同时编辑同一个 branch 时，更改会实时同步。页面内容、导航结构和站点配置的更新会自动出现在所有协作者那里，无需刷新。
|
||
|
||
- 每个人的光标和编辑都对页面上的所有人可见，工具栏中会显示用户的头像和姓名。
|
||
- 更改会自动合并。两人同时编辑同一段内容不会引起冲突。
|
||
- 撤销仅作用于你自己的更改——撤销不会回退他人所做的修改。
|
||
- 如果你失去网络连接，你的编辑会保存在本地，并在重新连接后同步。
|
||
|
||
<div id="see-the-agents-edits-in-real-time">
|
||
## 实时查看 agent 的编辑
|
||
</div>
|
||
|
||
当 [Mintlify agent](/zh/agent) 通过 API 或 MCP 编辑页面时，它会像任何其他协作者一样出现在 Web 编辑器中。如果你在同一 branch 上打开了该页面，你会在编辑器顶部看到 agent 的头像和名称，并在其最近一次编辑的位置看到实时光标。
|
||
|
||
可用于：
|
||
|
||
- 实时查看 agent 对页面所做的更改。
|
||
- 无需对比文件即可知道 agent 刚刚更新了哪个段落或区块。
|
||
- 在同一 branch 上与队友和 agent 协调工作，避免互相覆盖彼此的工作。
|
||
|
||
agent 完成编辑后不久，其光标会自动消失。
|
||
|
||
<div id="branch-based-collaboration">
|
||
## 基于 branch 的协作
|
||
</div>
|
||
|
||
使用 branch 并行更新文档，在不影响线上站点的前提下完成修改。如果你不熟悉 Git，请参阅 [Web 编辑器的 Git 基础](/zh/editor/git-essentials)。
|
||
|
||
<div id="why-use-branches">
|
||
### 为什么要使用 branch
|
||
</div>
|
||
|
||
- **隔离更改**：在不影响线上文档的情况下进行更新。
|
||
- **发布前评审**：在更改上线之前先获取团队成员的反馈。
|
||
- **并行协作**：多个团队成员可以同时在不同的 branch 上工作。
|
||
|
||
<div id="recommended-workflow">
|
||
## 推荐工作流
|
||
</div>
|
||
|
||
建议使用拉取请求（PR；亦称“合并请求”/Merge Request）在合并到线上文档之前提出更改并与团队协作。此工作流可以确保团队在发布前完成审查，并保持清晰的更新历史记录。
|
||
|
||
<Steps>
|
||
<Step title="创建拉取请求">
|
||
当你准备好发布更改时，可以在编辑器中创建拉取请求。更多信息请参阅 [Branching and publishing](/zh/editor/publish)。
|
||
</Step>
|
||
|
||
<Step title="审查拉取请求">
|
||
在你的 Git 托管平台（如 GitHub 或 GitLab）中审查拉取请求。
|
||
</Step>
|
||
|
||
<Step title="回应反馈">
|
||
当审查者请求更改时，在编辑器中进行所需的修改。后续的更改会自动推送到现有的拉取请求中。
|
||
</Step>
|
||
|
||
<Step title="合并拉取请求">
|
||
当所有请求的更改都已处理、必需审查者已批准且所有自动检查均已通过时，合并你的拉取请求。
|
||
</Step>
|
||
</Steps>
|
||
|
||
<div id="preview-deployments">
|
||
## 预览部署
|
||
</div>
|
||
|
||
预览部署会创建临时 URL，你可以在更改正式上线之前先查看渲染效果。使用预览部署来收集关于你更改的反馈。
|
||
|
||
每次你在某个 branch 上发布更改时，预览部署都会自动更新。
|
||
|
||
<div id="access-preview-deployments">
|
||
### 访问预览部署
|
||
</div>
|
||
|
||
1. 在编辑器工具栏中点击 **Publish**。
|
||
2. 点击预览 URL，在新标签页中打开预览部署。URL 的格式为 `organization-branch-name.mintlify.site`。
|
||
|
||
<div id="share-previews">
|
||
### 分享预览
|
||
</div>
|
||
|
||
将预览部署的 URL 分享给团队成员以收集反馈。当你发布更多更改时，预览会自动更新。
|
||
|
||
<div id="preview-authentication">
|
||
### 预览认证
|
||
</div>
|
||
|
||
预览 URL 默认对所有人公开可访问。在控制台的 [附加组件（Add-ons）](https://dashboard.mintlify.com/products/addons) 页面启用预览认证，以将访问限制为已通过认证的组织成员。
|
||
|
||
<div id="share-editor-links">
|
||
## 分享编辑器链接
|
||
</div>
|
||
|
||
将编辑器中某个特定页面的直接链接分享给你的团队成员。使用编辑器链接可以实时协作更新内容，或将队友定位到特定页面。
|
||
|
||
当你在页面之间导航时，编辑器 URL 会自动更新。从浏览器地址栏中复制该 URL，与有编辑器访问权限的团队成员分享。
|
||
|
||
URL 的格式是：`https://dashboard.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}`
|
||
|
||
例如，`https://dashboard.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` 会在 `main` branch 上打开 `quickstart.mdx` 文件。
|
||
|
||
任何有权访问你所在 Mintlify 组织的人都可以使用该链接直接在编辑器中打开该文件。
|