Skip to content

Editor updates #797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Editor updates #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56d971d
explain when publish pushes changes live
ethanpalm Jun 6, 2025
5fba5d5
clarify what an editor is
ethanpalm Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions advanced/dashboard/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: 'Editor Permissions'
description: 'Allow more members of your team to update your docs'
---

The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify.
An editor has access to your dashboard and web editor.

If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check.
Anyone can contribute to your documentation by working locally and pushing changes to your repository, but there are key differences in how changes get deployed:

<Frame>
<img className="rounded-md" src="/images/editor-gate.png" />
</Frame>
* **Editor changes**: When an editor publishes through the web editor or merges a pull request into your docs repository, changes deploy to your live site automatically.
* **Non-editor changes**: When a non-editor merges a pull request into your repository, you must manually trigger a deployment from your dashboard for those changes to appear on your live site.

In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates.
## Add editors
By default, the team member who created your Mintlify organization has editor access. Add additional editors in the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard.

Learn more about our pricing [here](https://mintlify.com/pricing).
Editor seats are billed based on usage, and you can have as many editors as you need. See our [pricing page](https://mintlify.com/pricing) for more details.
6 changes: 2 additions & 4 deletions editor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,10 @@ Markdown mode provides direct access to the underlying MDX code of your document
## Publishing

<Info>
Publishing directly updates your configured deployment branch. For collaborative workflows, consider using branches and pull requests instead.
Publishing from your main branch updates your live site immediately. To review changes before they go live, work on a separate branch and use pull requests.
</Info>

When you're ready to make your changes live, click the **Publish** button in the top-right corner of the web editor.

Your changes will be deployed to your production site immediately.
When you're ready to make your changes live, select the **Publish** button in the top-right corner of the web editor.

<Frame>
<img
Expand Down
2 changes: 1 addition & 1 deletion quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ When you are satisfied with your edits, click the `Publish` button in the top-ri

Your changes are immediately deployed to your documentation site.

For more details about using the web editor, including advanced features like slash commands and image uploads, see our [Web Editor documentation](/editor).
For more details about using the web editor, including using branches and pull request to collaborate and preview changes, see our [Web Editor documentation](/editor).

## Adding a Custom Domain

Expand Down