📚 Just let me read No commitment

Project docs grouped by audience. For an overview of the project, start at the root README.

Operators (running the faucet)

• admin-first-run.md — login → TOTP enrolment → fund wallet → first claim
• deployment-production.md — TLS, secrets, Postgres, Helm chart
• health-observability.md — what /healthz checks, alerting, logs
• smoke-testing.md — end-to-end testnet validation (BYO wallet or generate fresh)

Integrators (embedding in your app)

• claim-ui.md — ClaimUI architecture, abuse layer widgets, theming, reuse and customization guide
• integrator-hmac.md — HMAC-signed backend requests with Node / Go / curl examples
• Per-SDK READMEs: sdk-ts, sdk-react, sdk-vue, sdk-capacitor, sdk-react-native, sdk-flutter, sdk-go
• ../AGENTS.md — per-framework recipes for AI coding agents
• Developer Playground — interactive VitePress sandbox with paths, SDK guides, and runnable examples (deployed to GitHub Pages)

Maintainers (contributing to this repo)

• qa-testing.md — 12-phase hands-on walkthrough of every feature (AI-assisted)
• release-playbook.md — tag → publish flow, NPM_TOKEN provisioning, rc dry-runs
• release-polish-plan.md — historical pre-1.0 polish plan (reference)
• quality/runtime-core-quality-audit-2026-04.md — runtime core quality audit ledger (PRs, issues, recommendations)
• ../CONTRIBUTING.md — dev setup, repository layout, code style
• ../ROADMAP.md — post-1.0 plans + ongoing quality programs

Abuse Prevention

• abuse-layers/ — detailed documentation for all 9 abuse layers, providers, configuration, and how to add your own
• fraud-prevention.md — one-pager on the defense-in-depth strategy + trust connectors (for stakeholders)

Security

• security/threat-model.md — STRIDE analysis per component
• security/hardening-checklist.md — production hardening items
• security/owasp-top10.md — OWASP Top 10 per endpoint
• ../SECURITY.md — vulnerability reporting policy