Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help-center-starter-replace-template-content.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Mintlify builds and deploys your docs automatically in response to Git events. Here’s what triggers a deployment and how to configure each type.

​
Push to default branch

Every push to your repository’s default branch (typically main) triggers a production deployment. This is the primary trigger for most teams. To change the production branch, go to Project Settings → Git → Production branch.

​
Pull request previews

Every pull request against your default branch gets a preview deployment at a unique URL. Preview URLs look like https://[project]-[pr-number].mintlify.app. Share preview links in your PR description for reviews before merging. Preview deployments are deleted automatically when the PR closes.

​
Disabling previews

Preview deployments are enabled by default. Disable them in Project Settings → Git → Pull request previews if you don’t want them.

​
Manual redeploys

Trigger a deployment manually from the dashboard without making a code change:
  1. Go to [Project] → Deployments.
  2. Click Redeploy on the most recent successful deployment.
This is useful if you’ve updated an external resource (like an OpenAPI spec hosted at a URL) that your docs reference.

​
Branch deployments

Beyond the default branch, you can configure specific branches to deploy automatically. Go to Project Settings → Git → Additional branches to add branch patterns.
Branch deployments are useful for long-running feature branches or staging environments. Each branch gets its own subdomain under mintlify.app.