AFAuth Docs

Documentation for the AFAuth Protocol, published at docs.afauth.org.

Built with Mintlify.

Layout

• Authored here: concepts/, guides/, sdk/, cli/, reference/, snippets/.
• Synced from upstream — do not edit by hand:
  • spec/ ← AFAuthHQ/spec
  • sdk/typescript/*/reference/ ← AFAuthHQ/typescript-sdk (typedoc output)
  • cli/commands/ ← AFAuthHQ/cli (cobra doc-gen output)

Local development

npm install
npm run dev           # starts Mintlify on http://localhost:3000
npm run broken-links  # link check
npx mint validate     # strict build validation (what CI runs)

Syncing

• Spec syncs on every push to AFAuthHQ/spec@main (event-driven via repository_dispatch), with a 06:00 UTC cron as fallback.
• TypeScript SDK reference syncs on every release tag in AFAuthHQ/typescript-sdk.
• CLI reference syncs on every release tag in AFAuthHQ/cli.

Each sync opens a PR labelled automerge: <source>-sync. The PR auto-merges if:

1. Mintlify build passes
2. Link check passes
3. Diff-size sanity check passes (no >50% file deletion)

If any gate fails, the PR stays open with the failing check.

Wiring up the spec → docs trigger

In AFAuthHQ/spec, add a workflow that runs on push to main and calls:

- run: gh api repos/AFAuthHQ/docs/dispatches -f event_type=spec-updated
  env:
    GH_TOKEN: ${{ secrets.DOCS_DISPATCH_TOKEN }}

DOCS_DISPATCH_TOKEN is a fine-grained PAT with Actions: write on AFAuthHQ/docs, stored as a secret in AFAuthHQ/spec.

Manual sync

gh workflow run sync-spec.yml -R AFAuthHQ/docs

License

Specification text (synced from AFAuthHQ/spec) remains under CC-BY-4.0. All other content in this repo is under Apache-2.0.