> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Collaborate in the web editor

> Edit documentation with your team using real-time collaboration, live cursors, shareable editor links, branches, and pull request review workflows.

Collaborate with your team on documentation using real-time editing and branch-based workflows.

## Real-time collaboration

Multiple people can edit the same page at the same time. Changes from each person appear for everyone on the page.

To collaborate on a page in real time, share the editor link for that page with your teammates. See [Share editor links](#share-editor-links) below.

<Frame>
  <img src="https://mintcdn.com/mintlify/GiucHIlvP3i5L17o/images/editor/editor-light.png?fit=max&auto=format&n=GiucHIlvP3i5L17o&q=85&s=0579093c2743bb8f55c4f81bece9e902" className="block dark:hidden" alt="Web editor showing real-time collaboration with multiple cursors" width="1184" height="320" data-path="images/editor/editor-light.png" />

  <img src="https://mintcdn.com/mintlify/GiucHIlvP3i5L17o/images/editor/editor-dark.png?fit=max&auto=format&n=GiucHIlvP3i5L17o&q=85&s=09938d1ca65739f048de43183a5bbaab" className="hidden dark:block" alt="Web editor showing real-time collaboration with multiple cursors" width="1184" height="320" data-path="images/editor/editor-dark.png" />
</Frame>

### How real-time editing works

When multiple team members edit the same branch, changes sync in real-time. Page content, navigation structure, and site configuration updates appear automatically for all collaborators without refreshing.

* Each person's cursor and edits are visible to everyone on the page, with user avatars and names shown in the toolbar.
* Changes merge automatically. Two people editing the same section won't cause conflicts.
* Undo only affects your own changes—undoing won't revert another person's edits.
* If you lose your network connection, your edits save locally and sync when you reconnect.

## See the agent's edits in real time

When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears in the web editor like any other collaborator. If you have the page open on the same branch, you see the agent's avatar and name at the top of the editor and a live cursor at the location of its most recent edit.

Use this to:

* Watch agent changes stream into the page as they happen.
* See which paragraph or block the agent just updated without diffing the file.
* Coordinate with teammates and the agent on the same branch without overwriting each other's work.

The agent's cursor clears automatically a short time after the agent finishes editing.

## Branch-based collaboration

Use branches to work on documentation updates in parallel without affecting your live site. If you aren't familiar with Git, see [Git essentials for the web editor](/editor/git-essentials).

### Why use branches

* **Isolate changes**: Work on updates without affecting your live documentation.
* **Review before publishing**: Get feedback from team members before changes go live.
* **Parallel work**: Multiple team members can work on different branches simultaneously.

## Recommended workflow

Use pull requests to propose changes and collaborate with your team before merging to your live documentation. This workflow ensures your team reviews changes before publishing and maintains a clear history of updates.

<Steps>
  <Step title="Create a pull request">
    Create a pull request from the editor when you're ready to publish your changes. See [Branching and publishing](/editor/branching-and-publishing) for more information.
  </Step>

  <Step title="Review pull requests">
    Review pull requests in your Git provider like GitHub or GitLab.
  </Step>

  <Step title="Respond to feedback">
    When reviewers request changes, make the requested changes in the editor. Additional changes automatically push to the existing pull request.
  </Step>

  <Step title="Merge pull requests">
    Merge your pull request after addressing all requested changes, required reviewers approve, and any automated checks pass.
  </Step>
</Steps>

## Preview deployments

Preview deployments create temporary URLs where you can see your rendered changes before they go live. Use preview deployments to gather feedback on your changes.

Every time you publish changes to a branch, the preview deployment updates automatically.

### Access preview deployments

1. Click **Publish** in the editor toolbar.
2. Click the preview URL to open the preview deployment in a new tab. The URL format is `organization-branch-name.mintlify.app`.

### Share previews

Share the preview deployment URL with team members to gather feedback. Previews update automatically when you publish additional changes.

### Preview authentication

Preview URLs are publicly accessible by default. Enable preview authentication in the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard to restrict access to authenticated organization members.

## Share editor links

Share a direct link to a specific page in the editor with your teammates. Use editor links to collaborate on updates in real time or point teammates to a specific page.

The editor URL updates automatically as you navigate between pages. Copy the URL from your browser's address bar to share it with teammates who have access to the editor.

The URL format is: `https://dashboard.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}`

For example, `https://dashboard.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` opens `quickstart.mdx` on the `main` branch.

Anyone with access to your Mintlify organization can use the link to open the file directly in the editor.


## Related topics

- [Quickstart](/docs/quickstart.md)
- [快速入门](/docs/zh/quickstart.md)
- [Inicio rápido](/docs/es/quickstart.md)