This directory is the documentation index for Runway. The main guides currently live next to the code they describe, so implementation details stay close to the component they belong to.
Start with:
- Repository overview: architecture, prerequisites, local setup, Kubernetes setup, and API examples
- Service: HTTP API, service configuration, metrics, dead letter queue, tests, and Docker usage
- Python worker: execution modes, NATS protocol, worker configuration, tests, and Docker usage
- Helm chart: Kubernetes installation, image settings, ingress, external NATS, scaling, and worker sandboxing
- Load testing: k6 load-test image, local runs, and Kubernetes Job usage
- Examples: example requests, deployments, and integrations
Add separate documents here when a topic spans multiple components or becomes too large for a component README.