Public customer API documentation for Raptor Comply, published at docs.raptorcomply.com via Mintlify. Live preview: raptorcomply.mintlify.app.
| Path | Authored by | Notes |
|---|---|---|
introduction.mdx, authentication.mdx, quickstart.mdx |
Hand-written | Get Started section |
concepts/*.mdx |
Hand-written | Data model, organizations, permissions |
guides/*.mdx |
Hand-written | Integration guides (CMDB sync, cyber asset lifecycle, error handling) |
api-reference/*.mdx |
Hand-written today, auto-generated post Stage 2 | Per-resource reference pages. The Stage 2 generator in raptor-comply will regenerate these from the ts-rest contract + OpenFGA model. |
mint.json |
Hand-edited | Navigation, branding, top-level config |
images/, favicon.svg |
Hand-managed | Brand assets |
- All pages: edit on a
feat/branch, open a PR, merge after CODEOWNERS approval. - The Mintlify dashboard's Web Editor pushes changes to GitHub via PR; review there.
- Branch protection: PR + CODEOWNERS + stale-approval dismissal. No direct pushes, no force pushes. SOC2-style independent-review is intentionally NOT required because Peter is the sole CODEOWNER and the HITL reviewer for auto-PRs.
The forthcoming sync-customer-api-docs.yml workflow in
raptor-comply will regenerate
the api-reference/* pages on every change to the customer-facing contract or
the OpenFGA model. Updates land here via a force-updated auto/api-sync PR.
See the Mintlify API Docs Automation design and rollout plan for the full architecture.