mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
3a1e835d70
* add section on sharing editor links * disambiguate usage of preview deployments versus editor links
83 lines
3.7 KiB
Plaintext
83 lines
3.7 KiB
Plaintext
---
|
|
title: "Collaborate in the web editor"
|
|
sidebarTitle: "Collaborate"
|
|
description: "Work together on documentation with branches, pull requests, preview deployments, and shareable editor links."
|
|
keywords: ["editor", "collaboration", "branches", "pull requests", "preview deployments", "share links"]
|
|
---
|
|
|
|
Collaborate with your team on documentation using branch-based workflows, pull requests, and preview deployments.
|
|
|
|
If you aren't familiar with Git, see [Git concepts](/guides/git-concepts).
|
|
|
|
## Branch-based collaboration
|
|
|
|
Use branches to work on documentation updates in parallel without affecting your live site.
|
|
|
|
### 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 <a href="/editor/publish">Publish changes in the web editor</a> for more information on using pull requests.
|
|
</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 and save your changes. 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 the pull request, 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 how changes.
|
|
|
|
### Access preview deployments
|
|
|
|
1. Click **Share** in the editor tool bar.
|
|
2. Click **Preview** to open the preview deployment in a new tab.
|
|
3. The preview URL shows your documentation with all saved changes applied.
|
|
|
|
<Frame>
|
|
<img src="/images/editor/share-preview-light.png" className="block dark:hidden" alt="Share button in the editor toolbar" />
|
|
<img src="/images/editor/share-preview-dark.png" className="hidden dark:block" alt="Share button in the editor toolbar" />
|
|
</Frame>
|
|
|
|
### Share previews
|
|
|
|
Share the preview deployment URL with team members to gather feedback. Previews update automatically when you save 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 and make changes to pages.
|
|
|
|
When you open a page, the editor saves the path in the URL. 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}?file={filepath}
|
|
```
|
|
|
|
For example, `https://dashboard.mintlify.com/acme/docs/editor/main?file=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.
|
|
|
|
<Tip>
|
|
When you share a page, tell people which branch you're working on so they can confirm they view the correct version.
|
|
</Tip>
|