Auths Documentation

This repository builds the public docs.auths.dev experience from free-form editorial MDX and an immutable, checksum-addressed Auths product snapshot.

The product contract is:

• begin with outcomes and five stable verbs;
• progressively disclose protocol and operational depth;
• generate reference facts from installed SDK and runtime artifacts;
• render maintained TypeScript and Python recipes from pinned product source; and
• publish equivalent HTML and canonical Markdown for people and agents.

Information architecture

content-v2/navigation.json owns the homepage route, the public documentation routes, top navigation placement, left navigation groups, and page ordering. The four primary destinations are:

• /start — choose a first workflow and run a maintained quickstart;
• /guides — integrate Auths and understand the authority and verification models;
• /examples — inspect production-shaped examples by security question; and
• /reference — look up the exact SDK, protocol, outcome, and evidence surfaces.

Conceptual material lives inside Guides rather than in a separate top-level section. The custom homepage layout reads its copy from the registry-owned content-v2/home.json, which also generates /index.md and machine-readable discovery entries.

Local development

Requires Node.js 22 or later.

npm install
npm run dev

Run the production build and checks:

npm run docs:build
npm run routes:check
npm run typecheck
npm run build
npm run lint
npm run audit:docs

Architecture decisions

Read:

• docs/TOOLING.md
• docs/DESIGN_LANGUAGE.md
• docs/ARCHITECTURE.md
• docs/MAINTENANCE.md

The site is static-first. Product facts enter only through product-snapshot/; editorial explanations live under content-v2/. The site has no production database, provider credentials, or runtime authority. Client JavaScript is reserved for search, navigation state, synchronized language selection, and copy actions.