Skip to main content
A Git diff shows which lines changed. A preview shows what those changes do to the documentation site. When the Mintlify GitHub app has access to your repository, pull requests receive a preview deployment of the proposed branch. New commits update the preview, so reviewers can follow the same link throughout the pull request.

​
Find the preview

Open the pull request and look for the Mintlify preview in its conversation or checks. The deployment may still be building when the pull request first opens, so check its status if the link isn’t ready yet. If no preview appears:
  1. Confirm that the pull request targets the configured deployment branch.
  2. Check that the Mintlify GitHub app can access the repository.
  3. Look at the deployment status in the Mintlify dashboard.

​
Review what readers will experience

Start with every page changed by the pull request. For each one, check:
  • The page renders without broken MDX or missing media
  • The edited section makes sense with the paragraphs around it
  • Links and interactive components behave as expected
  • Headings and the table of contents describe the page clearly
Then check the effects beyond those pages. A small docs.json edit can move several pages, change a label, or remove something from navigation. Follow the relevant path through the sidebar instead of checking only the URL you were given. For layout-heavy changes, resize the browser or check a mobile viewport. You don’t need to test every screen size on every copy edit; focus the review on what the change could plausibly affect.

​
Give reviewers a specific task

Share the preview with a short review request. For example:
Please check the new authentication flow from Create a token through Test the request. In particular, does the choice between service and user tokens make sense before step one?
That is more useful than “Thoughts?” Reviewers know where to start and what kind of feedback you need. Preview URLs are publicly accessible by default. Organizations can enable preview authentication, so confirm the access setting before sending a link outside your team. A reviewer who can open an authenticated preview may need a Mintlify organization account even if they don’t use GitHub.

​
Treat the preview and diff as a pair

The preview can reveal bad layout or navigation, but it won’t show an unrelated file added to the commit or a secret removed before rendering. Review the Git diff for source changes and the preview for the reader experience. Next up: Collaborating with your team — make reviews useful and handle overlapping work without losing changes.