review.md

Review changes

Preview changes before they go live, share them with your team, and approve and merge pull requests from the editor.

Preview your changes before they reach your live site, then review and merge the pull request without leaving the editor.

Live preview

Live preview renders your site as you edit, with no build step. Click the live preview button in the top bar.

To edit site settings and see how they affect your content, click Site settings in the preview toolbar, then select a configuration section. This menu is unavailable if you have Open live preview in new tab enabled.

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 is only available for public sites and sites protected by Mintlify authentication.

Preview deployments

When you open a pull request from a feature branch, Mintlify builds a preview deployment: a temporary URL where your changes render exactly as they look when published. The preview rebuilds each time you save 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 Add-ons 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	Local URL	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, copy the URL from your browser's address bar. Anyone with access to your Mintlify organization can open it in their own editor session.

https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}

For example: https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx

Review and merge pull requests

When a pull request is open for the current branch, the publish menu shows a review panel with the number of changed files and current review status.

After a reviewer approves, click Merge and publish to merge and deploy from the editor. The editor switches you back to your deployment branch after merging.

Approve from the editor

For GitHub repositories, reviewers can approve open pull requests without leaving the editor. An Approve pull request button appears in the review panel if your account has permission to review it. The status updates to Approved and Merge and publish becomes available.

If you use GitLab or Bitbucket, open the pull request in your Git provider to approve it.

Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub help or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) 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. 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.

Hidden pages that appear in the branch diff are openable from the publish menu, even though they don't appear in your site navigation.

Pull request titles and descriptions

If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor generates one listing the files you created, updated, moved, or deleted. To control how the editor writes them, set PR instructions.

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, you can open the editor on the automation's branch:

From the Runs tab on the Automations page in your dashboard, click Preview on a result awaiting review.
From a Slack notification, click the View changes link.

Either entry point opens the editor on the automation's branch with the changed pages preselected in the publish menu, so you can review the diff and merge or request changes without leaving the editor. The agent opens alongside it with context on what the automation did.