Developers

Internal engineering map for architecture, setup, ADRs, and the public API stack.

Internal documentation for engineers working on the Basenet rebuild. Partner-facing API guides live under Partner.

Start here

1. Quickstart — apps, packages, and how to orient
2. Architecture — monorepo and runtime map (Mermaid)
3. Application architecture — transports → handlers → permissions/transactions/audit → repositories/providers
4. Tenant isolation — routing, database-per-tenant provisioning, fleet migrations and failure boundaries
5. Workers and integrations — queues, adapters, retries, idempotency and dead letters
6. Setup and checks — pnpm dev and day-to-day commands
7. Operations and runbooks — every current runbook, grouped by purpose
8. Real-tenant dev fixtures — boot on migrated Basenet-shaped data
9. Public API & docs — OpenAPI → Blume / Scalar / OpenWiki (Mermaid)
10. Scalar API reference — the live /reference viewer, auth reality, and which surface to use when
11. Decisions & ADRs — why boundaries exist
12. Testing — unit, fleet, e2e expectations
13. OpenWiki — generated wiki vs this browsable surface

Local docs server

pnpm --filter @blinqx/docs dev
# → http://localhost:4322

Port 4322 is intentional (not Astro’s default 4321) so it stays clear of web:3000 and portal:3001.

Contract symlink

One OpenAPI artifact feeds every surface — see Public API & docs and docs/runbooks/docs-surfaces.md.