Skip to main content
Use least privilege. Most teammates should be readers or contributors; a smaller group should be able to merge and administer the project.

Review rules

  • Routine corrections need one reviewer familiar with the subject.
  • Policies require the named approval authority.
  • Security-sensitive or production runbook changes require an appropriate technical reviewer.
  • Authors should not be the only reviewer of material that creates an obligation or operational risk.
Protect the deployment branch and require pull requests, at least one approval, and the documentation validation check. Limit direct pushes to administrators. Keep the repository private and grant the Mintlify GitHub App access only to this repository.

Publishing model

Connect the main branch to Mintlify as the deployment branch. Repository changes deploy to the site, while web-editor publishing commits back to Git or creates a pull request when the contributor works on a feature branch.