diff --git a/advanced/dashboard/permissions.mdx b/advanced/dashboard/permissions.mdx index d39d099a..9a54aacf 100644 --- a/advanced/dashboard/permissions.mdx +++ b/advanced/dashboard/permissions.mdx @@ -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: - - - +* **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. diff --git a/editor.mdx b/editor.mdx index f7fa4958..524a105b 100644 --- a/editor.mdx +++ b/editor.mdx @@ -112,13 +112,10 @@ Markdown mode provides direct access to the underlying MDX code of your document ## Publishing - - Publishing directly updates your configured deployment branch. For collaborative workflows, consider using branches and pull requests instead. - +The **Publish** button works differently depending on your branch: -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. +* **Deployment branch**: Updates your live site immediately. This is usually the `main` branch. +* **Other branches**: Creates a pull request for review. Use branches for significant updates, new sections, or when multiple team members are working on different parts of the documentation simultaneously. @@ -161,7 +158,7 @@ When you are working on a branch, your changes are not automatically saved. ## Pull Requests -Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your main documentation. +Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your documentation. ### Creating a Pull Request on a Branch @@ -189,7 +186,7 @@ You can review pull requests in your Git platform (GitHub, GitLab). After you create a pull request, you can see a preview deployment of the changes. -After a reviewer approves a pull request, you can merge the pull request into your main branch and the changes will be deployed to your live documentation site. +After a reviewer approves a pull request, you can merge it to deploy the changes to your live documentation site. ## Git Synchronization @@ -199,11 +196,11 @@ The web editor integrates with your Git repository, ensuring that all changes ar * **Authentication**: The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab). -* **Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's main branch. +* **Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's deployment branch. * **Change tracking**: As you make edits, the web editor tracks changes and can commit them to your repository. -* **Branching**: You can make changes directly to your main branch or to a separate branch, depending on your workflow preferences. +* **Branching**: You can make changes directly to your deployment branch or to a separate branch, depending on your workflow preferences. * **Pull requests**: For collaborative workflows, you can create pull requests from the web editor. @@ -227,7 +224,7 @@ A commit is a snapshot of changes to your documentation at a specific point in t -A branch is a parallel version of your documentation that allows you to work on changes without affecting the main version. The web editor allows you to create and switch between branches. +A branch is a parallel version of your documentation that allows you to work on changes without affecting the live version. The web editor allows you to create and switch between branches. diff --git a/quickstart.mdx b/quickstart.mdx index 981c33cc..4be95c6e 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -189,11 +189,13 @@ Then, in the visual editor, update the title field to "Hello World". ### Publish Your Changes -When you are satisfied with your edits, click the `Publish` button in the top-right corner. +When you are satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. -Your changes are immediately deployed to your documentation site. + +Use branches to preview and review changes through pull requests before deploying to your live 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