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