Skip to main content

​
Scope

  • Public docs live in mintlify-docs/.
  • Internal engineering docs live in docs/.

​
Local Preview

From mintlify-docs/: 
npm i -g mint
mint dev

​
Validation

mint broken-links
make docs-openapi

​
Update Workflow

  1. Edit or add page content in mintlify-docs/.
  2. Register new pages in mintlify-docs/docs.json.
  3. Run make docs-openapi if backend API contracts changed.
  4. Run mint broken-links.
  5. Commit with related internal doc updates when contracts/behavior changed.

​
Documentation Rule

If a behavior contract changes in code, update both:
  • internal docs (docs/)
  • public docs (mintlify-docs/)