GitHub

Sync your docs with a GitHub repo

Mintlify integrates with GitHub through a GitHub App to sync your documentation with your repository.

Installation

1. Install the Mintlify GitHub App through the Mintlify dashboard
2. Select the repository where your docs are hosted
3. Grant the required permissions

Permissions

The GitHub App requires the following permissions:

• Read and write access to checks, contents, deployments, pull requests, and workflows

These permissions enable:

• Fetching and updating doc content
• Creating preview deployments for pull requests
• Managing branches and pull requests through the Mintlify web editor

The GitHub App only has access to repositories you explicitly grant it access to and follows your branch protection rules.

You can modify repository access anytime in your GitHub app settings.