This repository is the canonical public documentation source-of-record for HUMMBL AI governance infrastructure. It is built with Mintlify and deployed from the default branch.
- Public docs for HUMMBL governance primitives, compliance frameworks, Base120, tools, and REST API
docs.json— Mintlify site configuration (navigation, theme, branding)*.mdx— documentation source pagesdocs/adr/— public architecture decision records
Install the Mintlify CLI:
npm i -g mintRun the dev server from the repo root (where docs.json is located):
mint devPreview at http://localhost:3000.
Changes pushed to main are deployed to production automatically via the Mintlify GitHub App. Do not push to main without review. All public-facing claims must pass the claim-evidence policy before publication.
A CI workflow (.github/workflows/validate-docs.yml) runs on every PR and push to main:
- Navigation integrity —
python3 scripts/validate_docs.pychecks everydocs.jsonpage reference resolves to an existing.mdxfile - Claim-surface check —
python3 scripts/check_claims.pyflags stale quantitative claims (test counts, primitive counts, compliance frameworks, API endpoints)
Both scripts are reproducible locally by agents. Run them before pushing to main.
Public docs that make compliance, primitive-count, test-count, or product capability claims must cite the internal evidence ledger or current primary source. See:
hummbl-dev/hummbl-governance— governance primitives sourcehummbl-dev/founder-mode— integration testbed and canonical test countshummbl-dev/claim-evidence-ledger— claim tracking
hummbl-dev/mintlify-docs— staging/experimental docs surfacehummbl-dev/hummbl-dev— org-level README and public metadatahummbl-dev/hummbl-production— production deployment configs
- Create a branch from
main. - Edit
.mdxfiles ordocs.json. - Preview locally with
mint dev. - Open a PR. Ensure no unverified claims are introduced.
- After review and merge, changes deploy automatically.