This repository uses the mintlify/ folder as the canonical source for public documentation. To avoid divergence between internal engineering docs and public docs, follow these rules:
- Edit public-facing content only under
mintlify/ (MDX files) and update mintlify/docs.json when changing navigation.
- Internal documentation for engineering, architecture, security, and operational runbooks remains in
docs/ and is not surfaced in the public Mintlify site.
- After updating
mintlify/, run the local Mintlify dev or CI steps to validate build: mintlify build or mintlify dev.
- Use
npm run generate:openapi to refresh API specs and then update mintlify/api/ pages when the API surface changes.
If a page must be published publicly but currently exists under docs/, move or copy it to mintlify/ and ensure frontmatter and paths match the intended public route.
Automation: CI should run a docs-sync step that validates mintlify/ is the only source for public pages and fails the build when docs/ contains files listed in mintlify/docs.json. Last modified on March 24, 2026