This directory is the user-facing documentation for Quay.
It is written from the current implementation and tests, not from the older
design specs. The specs in docs/quay-spec*.md are useful design history, but
they have not been maintained all the way. If a spec and these docs disagree,
verify against the CLI implementation and tests, then fix the docs.
- Quickstart: build Quay, register a repo, enqueue a task, and run a demo tick loop.
- Concepts: the core terms behind the task lifecycle.
- Installation: build and install the binary.
- Configuration:
config.toml, data directories, defaults, and adapter settings. - External Services Setup: GitHub, Slack, Linear, worker credentials, and scheduler environment setup.
- Repositories: register repos and materialize bare clones.
- Enqueueing Tasks: manual briefs and Linear-backed enqueue.
- Running Quay:
quay tick, lifecycle states, retries, and cancellation. - Monitoring And Artifacts: task JSON, events, and artifact retrieval.
- Linear And Slack: adapter setup and behavior.
- Parent-Owned Umbrella QA Matrix: deployed Linear and test-repo validation scenarios for dependency and umbrella flows.
- Ticket Authoring: the
quay-configblock and ticket validation. - Troubleshooting: common errors and recovery paths.
- CLI Reference: command inventory and output conventions.
These docs are for:
- Operators installing and running Quay on a single host.
- Orchestrator authors integrating with Quay through the CLI.
- Engineers debugging task state, artifacts, repo registration, and adapter behavior.
They are not a replacement for the internal design notes. Use the specs when you need architectural context, but use these docs when you need to run the tool.