Docs - Istravex

These docs live in docs/ in the main repository, next to the code they describe, and are published by Mintlify to docs.istravex.com.

Numbers are generated, not typed

Every result table in the docs (fixtures, SDK results, replay verdicts, pilot checks, CAP coverage) is generated from corpus/:

File	Generated by
`docs/snippets/*.mdx`	`kit/site-data.mjs` (`npm run corpus:data`)
`docs/corpus/cap-coverage.mdx`	`kit/audit/caps.mjs` (`npm run corpus:audit`)
`docs/api-reference/openapi.json`	Copied from `server/openapi.json` by `kit/site-data.mjs`

CI regenerates them and fails if the committed copies differ, so the docs can’t drift from the corpus. Pages import snippets like any MDX component:

import Numbers from '/snippets/numbers.mdx';

<Numbers />

Previewing locally

npm i -g mint
cd docs
mint dev            # http://localhost:3000
mint broken-links   # check every internal link

Publishing

Connect the repository

In the Mintlify dashboard, install the Mintlify GitHub app on hackcat29/istravex. Under Git Settings, enable docs.json is in a subdirectory and set the path to /docs. Every push to main then deploys the docs.

Custom domain

Under Custom domain setup, add docs.istravex.com. Add the two TXT records the dashboard shows (_acme-challenge.docs and _cf-custom-hostname.docs) first, wait for both to verify, then add:

Type	Name	Value	Proxy
CNAME	`docs`	`cname.mintlify.builders`	DNS only

The istravex.com zone is on Cloudflare: add all three records there, with the proxy off (grey cloud), since Mintlify issues the certificate. If the zone has CAA records, include 0 issue "letsencrypt.org".