0
0
docs
Start at the README. Agents: ../AGENTS.md first.
Use
| doc | what |
|---|---|
| quickstart-prod.md | request from prod bidders: vouches, a command, hold and ssh, sizes, sign-in, run requester |
| quickstart-local.md | a whole market on one machine: dev up, request, kubectl apply, dev down |
| bidder.md | builds and channels, install a bidder, who it serves, upgrade, self-update, uninstall |
| gateway.md | Kubernetes clusters from the gateway; its deploy environment |
| deploy.md | how a release reaches prod: CI, channels, what survives, rollback |
| inspect.md | reading live state |
| oauth.md | scripted OAuth sign-in |
| host-contract.md | what a host must provide (check-host) |
How it works
| doc | what |
|---|---|
| how-it-works.md | the protocol in one page: the flow, who is who, who serves whom |
| protocol/flow.md | one contract end to end, with its real records and failure branches |
| protocol/compute-contract-flow-map.md | the compute contract flow map: every layer from the lexicons to the guest transport |
| SYSTEM.md | the whole system: repos, hosts, apps, market protocol, guests, identity, ssh gateway, atirc, clusters |
| protocol/README.md | the atproto lexicons and the end-to-end sequence; protocol/glossary.md: every NSID |
| lexicon reference | every record, object and method, generated from ../lexicons/ (on the site) |
| XRPC reference | the XRPC methods, generated from the same files (on the site) |
| KCP.md | how every app uses kcp |
| ARCHITECTURE.md | decisions, measurements, invariants (open a section by heading) |
| ../deploy/market-network/README.md | the one-kcp market network |
| infra/inventory.md | what runs where on the non-gateway hosts |
Verify and coordinate
| doc | what |
|---|---|
| acceptance/ | the acceptance runbooks |
| ci-debug.md | CI by hand, debugging a CI run |
| ATIRC-WORKFLOW.md | how agents coordinate over atirc |
| plans/ | plans and their status |
| spec/, research/ | integration catalog, research notes |