Skip to content

u22a8/docs

Repository files navigation

U+22A8 docs

Public documentation for u22a8.ai, built on Mintlify and deployed to docs.u22a8.ai.

This site documents public surfaces only — the REST API, the MCP server, authoring schemas, and the concepts behind trait scoring. It never describes internal architecture, infrastructure, or anything that isn't shipped. The full writing and content rules live in CLAUDE.md (symlinked as AGENTS.md); read it before contributing.

Local development

npm i -g mint        # one-time: install the Mintlify CLI
mint dev             # preview at http://localhost:3000
mint broken-links    # validate internal links
mint validate        # strict build check + validate the OpenAPI spec

CI (.github/workflows/ci.yml) runs mint broken-links and mint validate on every PR and push to the default branch — both must pass before publish. Two further checks run out of band in the monorepo's scheduled /police sweep (when it has this repo checked out): an internal-leak scan (kept private — its rule set names internals) and OpenAPI freshness (snapshot vs the live spec, via scripts/openapi_freshness.py). Police fixes drift and refreshes the snapshot in a docs-sync PR for review. scripts/openapi_freshness.py is not sensitive and can be run locally.

Structure

docs.json                  # site config: theme, navigation, API, agent features
index.mdx                  # overview
quickstart.mdx             # get a key → first score
authentication.mdx         # keys, scopes, namespaces
concepts/                  # Explanation pages (score-card.mdx is the template)
api-reference/
  introduction.mdx         # REST overview + curated examples
  openapi.json             # review-gated snapshot of https://u22a8.ai/v1/openapi.json
logo/ , favicon.svg        # brand assets (the ⊨ mark)
CLAUDE.md  (← AGENTS.md)   # standalone context + writing/IA rules

Publishing

Changes merged to the default branch deploy automatically via the Mintlify GitHub app. Pull requests get preview deployments. The user manages git — agents make edits in place and do not commit, push, or branch.

AI-assisted authoring

npx skills add https://mintlify.com/docs   # install Mintlify's authoring skill

The API reference auto-generates from api-reference/openapi.json. Refresh it deliberately by re-fetching https://u22a8.ai/v1/openapi.json, diffing, and reviewing — never point at the live spec, so a new endpoint can't appear unreviewed.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors