Review changes

Preview changes before they go live, require approval before publishing, request and approve reviews, and merge pull requests from the editor.

Preview your changes before they reach your live site, ask teammates to approve them, and publish or merge them from the editor.

​

Live preview

Live preview renders your site as you edit, with no build step. With a site page open, click Preview in the top bar. The preview opens full screen. Click Refresh preview to reload it, or Close preview to return to the editor. To open the preview in a new browser tab instead, turn on Open live preview in new tab.

To edit site settings and see how they affect your content, click Site settings in the preview toolbar, then select a configuration section.

To open the agent beside the preview, click Ask agent in the preview toolbar. Only editors and admins can use the agent in live previews.

Live preview isn’t available for sites that use standalone personalization without authentication.

​

Preview deployments

When your feature branch has a pull request, Mintlify builds a preview deployment: a temporary URL where your changes render exactly as they look when published. The preview rebuilds each time the editor commits new changes to the branch. The URL combines your project’s subdomain and the branch name: <subdomain>-<branch-name>.mintlify.site. Find the exact URL in the pull request comment from the Mintlify bot.

Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication in the Previews section of the Site page in your dashboard. See Restrict access to preview deployments for more information.

​

Which preview to use

Feature	Live preview	Preview deployment
Speed	Instant	Requires a build
Access	Inside the editor	Shareable URL
Use when	Reviewing changes while editing	Sharing with your team for review
Availability	While the editor is open	As long as the branch exists

​

Share an editor link

To point a teammate at a specific page on a branch, click More options in the top-right of the page, then click Copy link. Anyone with access to your Mintlify organization can open the link in their own editor session.

​

Require review before publishing

To require review before publishing, you must have an Enterprise plan and your project’s repository must be on GitHub.

If an admin turns on Require review before publishing, changes on your deployment branch need a teammate’s approval before an admin or publisher can publish them. Admins can publish their own changes without review.

If you make changes on a feature branch, reviewers approve the pull request in your Git provider, and only admins can merge it into your deployment branch from the editor. See Review and merge pull requests.

Each role has different publishing permissions.

Role	Request a review	Approve changes	Publish approved changes	Publish without review
Owner and admin	Yes	Yes	Yes	Yes
Publisher	Yes	Yes	Yes	No
Editor, if your organization has the publisher role	Yes	No	No	No
Editor, if your organization doesn’t have the publisher role	Yes	Yes	No	No
Commenter	No	No	No	No
Viewer	No	No	No	No

​

Request a review

1. Make your changes on your deployment branch.
2. Click Request review in the top bar. This button replaces Publish when your changes need review.
3. In the Request review section, click Choose reviewers and select people or a group. You can only choose members who can approve changes.
4. Click Request.

The request includes every page you changed that isn’t already in review. Each reviewer gets an email and an item in their inbox.

Admins can publish without review, but they can also request a review from the Publish menu.

​

Review and approve changes

1. Open the review request from your inbox or email, or open a page that someone requested you to review.
2. Read the changes. To leave comments or suggestions instead of approving, use the comment and suggestion tools. Comments and suggestions don’t approve or block a review.
3. Click Approve in the banner at the top of the page. Your approval applies to every page in the request.

You can’t approve your own review request.

​

Publish approved changes

When someone approves a review request, the requester gets an inbox item notifying them of the approval. Admins and publishers can publish the approved changes.

1. Open a page in the approved request.
2. Click Publish in the top bar. The Publish menu lists the requester’s changes.
3. Click Publish followed by the requester’s name, such as Publish Ronan’s changes, then click Publish to confirm.

The approved pages publish along with any navigation and configuration changes. If another open review request includes changes to your navigation or configuration, any navigation and configuration changes remain unpublished until the other review request is approved or withdrawn.

​

Edit a page after approval

An approval applies only to the version of a page that the reviewer approved. If you edit, rename, or move an approved page, you must request a new review before publishing.

​

Withdraw a review request

To withdraw your review request before anyone approves it, open a page in the request and click Withdraw in the banner.

To remove one reviewer, open the Publish menu and click Withdraw next to the reviewer’s name. If you remove all reviewers, the request closes.

If you discard all changes in a request, the request closes.

​

Review and merge pull requests

When your branch has a pull request, the publish menu shows its changed files and review status, like Pull request created, Review required, Changes requested, or Approved. If Mintlify hosts your repository, a draft shows Draft in progress. If your repository is on GitHub or GitLab, click View request to open the pull request in your Git provider.

If the branch has unresolved comment threads, the publish menu shows a warning with the number of open comments in place of Ready to publish or Approved. You can still merge and publish. The warning reminds you to resolve feedback first.

On a feature branch, reviewers approve your changes in your Git provider, not in the editor. If your project requires review before publishing, only admins can merge pull requests into your deployment branch from the editor.

1. Click Publish in the top bar, then click Request review. This marks the pull request ready for review.
2. Reviewers approve the pull request in your Git provider.
3. Click Publish, then click Merge and publish. The editor merges the pull request, deploys your changes, and switches you back to your deployment branch.

If Mintlify hosts your repository and approvals aren’t required, the publish menu shows Publish instead, which merges and deploys in one step.

Configure branch protection rules in your Git provider to require pull requests. See About protected branches in the GitHub help or Protected branches in the GitLab help.

​

Compare changes before merging

Click any changed file in the publish menu to open it in diff view against the published version. To leave diff view, click Viewing changes in the top bar. Visual mode shows a visual diff and source mode shows a text diff. Files that can’t display a diff, such as images or deleted files, appear in the list but aren’t clickable.

You can open hidden pages that appear in the branch diff from the publish menu, even though they don’t appear in your site navigation.

​

Pull request titles and descriptions

The pull request title comes from your branch title.

If your branch has open comment threads, Mintlify adds a summary of them to the pull request description. See Collaborate.

​

Review an automation run

When an automation opens a pull request, click View changes in the Slack notification or notification email to open the editor on the automation’s branch. The editor opens in diff view, and the agent opens alongside it with context on what the automation did.

To open the automation’s preview deployment instead, open the run from the Runs tab on the Automations page of your dashboard, then click Preview.