This page is for maintainers who deploy the documentation site. Mintlify’s GitHub app must point directly to the monorepo directory that contains docs.json.
Connect the repository
Connect this repository in the Mintlify dashboard, enable the monorepo setting, and set the documentation path to /apps/docs.
Do not include a trailing slash in the documentation path. Mintlify looks for docs.json at the exact directory you configure.
Check a change before deployment
docs:build is the deployment validation gate: it runs the pinned Mintlify validate command and does not emit a local production directory.
Pushing to the branch configured in Mintlify triggers the hosted deployment. Deployment history and custom-domain settings remain in the Mintlify dashboard.
Production checklist
- Confirm the GitHub app can read the repository.
- Set the monorepo documentation path to
/apps/docs.
- Choose the deployment branch.
- Configure the production subdomain or custom domain.
- Require
bun run docs:check in the repository’s CI policy when the site becomes public.
