Set up PR previews

Use pull request previews to review docs changes before they go live.

Pull request previews give every docs change its own live URL for review before merging. This is the foundation of a safe docs review workflow.

How PR previews work

When you open a pull request against your default branch, Mintlify automatically builds and deploys the changes at a unique preview URL. The URL appears in your PR comments as a status check.

No configuration required — previews are enabled by default for all projects connected to GitHub or GitLab.

Using previews effectively

1. Open a PR for your docs change

   Make your docs changes in a branch and open a pull request. The Mintlify GitHub App posts a comment with a link to the preview deployment once the build completes.

2. Share the preview with reviewers

   Copy the preview URL and add it to the PR description or a comment. Reviewers can see the rendered page without checking out the branch locally.

3. Iterate on feedback

   Push additional commits to the branch — each push updates the preview deployment automatically. Reviewers can reload the preview URL to see changes.

4. Merge and deploy

   When approved, merge the PR. Mintlify deploys to production automatically within seconds.

Adding Mintlify as a required check

To enforce previews and require a successful build before merging:

1. In GitHub, go to Repository → Settings → Branches → Branch protection rules.
2. Add a rule for your default branch.
3. Enable Require status checks to pass before merging.
4. Search for and add the Mintlify status check.

This prevents broken docs changes from reaching production.