GitHub

Sync your docs with a GitHub repo

Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.

Installing the GitHub App

Install the Mintlify GitHub App on the GitHub account or organization that owns your docs repository. You must have organization ownership or admin permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.

Install the Mintlify GitHub App through your dashboard.

We recommend granting access only to the repository where your docs are hosted.

Permissions

When you install the GitHub app, you will be prompted to grant the following permissions:

Read permissions:

• metadata: Basic repository information

Read and write permissions:

• checks: Create status checks on pull requests
• code: Read file changes when you commit to your docs branch
• deployments: Generate preview deployments for pull requests
• pull requests: Create branches and pull requests from the web editor
• workflows: Manage GitHub Actions for docs deployments

The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app cannot push directly to protected branches.

Managing repository access

When installing our GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to the repositories where your documentation is located. You can modify this selection anytime in your GitHub app settings.

Configuring docs source

Change the organization, repository, or branch that your documentation is built from in the Git Settings section of your dashboard.

Troubleshooting

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

1. Uninstall the Mintlify app through GitHub.

   1. In GitHub, go to installations and select Configure next to the Mintlify app. Scroll down and select Uninstall.
   2. Go to Authorized GitHub Apps and select Revoke next to the Mintlify app.
2. Reinstall the Mintlify app.

   1. In your Mintlify dashboard, go to Git Settings and install the GitHub app.
   2. Authorize your account in the My Profile section of your dashboard.