Skip to main content
Beyond PR previews, you can configure Mintlify to deploy specific branches to dedicated, persistent environments. This is useful for staging environments or long-running feature branches.

​
Configure branch deployments

  1. Go to Project Settings → Git → Additional branches.
  2. Add the branches or branch patterns you want to deploy automatically.
  3. Each branch gets a unique subdomain: [project]-[branch].mintlify.app.

​
Branch patterns

You can use wildcards to match multiple branches:
  • staging — deploy the staging branch.
  • feature/* — deploy any branch starting with feature/.
  • release/* — deploy any branch starting with release/.

​
Common patterns

​
Staging environment

Use a staging branch as a buffer before production. Writers merge to staging for internal review, then merge to main for production release.

​
Version-specific docs

For products with multiple supported versions, deploy each version from a separate branch:
  • v1 branch → v1.docs.yourcompany.com
  • v2 branch → v2.docs.yourcompany.com
Use Mintlify’s versioning feature in docs.json to add a version selector within a single project instead if you prefer to keep versions in one place.
Branch deployments count toward your plan’s project limits. Check your plan details if you’re adding many branch environments.