ABI’s published documentation lives under this directory and is configured by
docs.json. The public site is served by Mintlify (GitHub app /
linked project that publishes from this tree). It is not a custom static
gh-pages tree for the main docs. Separately, optional benchmark dashboards may
use the gh-pages branch via .github/workflows/benchmarks-gh-pages.yml.
GitHub Actions validates the Mintlify site on every push/PR (docs-validate
job in .github/workflows/ci.yml).
| Path | Role | In Mintlify nav? |
|---|---|---|
index.mdx |
Hub (Cards → contracts / identity / architecture) | Yes |
contributing.mdx |
Doc contribution + claim rules | Yes |
contracts/*.mdx |
Frozen public surfaces + external claims audit | Yes |
spec/abbey-core-identity.mdx |
Canonical Abbey / Aviva / ABI / WDBX identity + evidence map | Yes |
spec/*.mdx |
Architecture / north-star / ops (Current/Partial/Proposed) | Yes |
superpowers/ |
Working plans/specs + archive — not public contracts | No |
tutorials/ |
How-to guides (not in Mintlify nav) | No |
research/ |
Research notes and PoC plans | No |
When prose disagrees with code, trust build.zig, src/, tests/contracts/, and
./build.sh check. Claim boundaries:
contracts/external-claims-audit.mdx.
Persona / product identity direction:
spec/abbey-core-identity.mdx and
src/features/ai/identity.zig.
.agents/skills/docs-validate/validate.sh
Requires an LTS Node (22.x; Mintlify rejects Node 25+). Preview: cd docs && npx mint@latest dev.
superpowers/archive/ (or draft .md plans) to docs.json navigation.contracts/public-api.mdx.