Reference
Lookup pages generated from the code, so they cannot drift from it: CI regenerates them (go run ./cmd/docgen -check) and fails when a committed page differs. To change one, change its source and run make docs-gen.
| Page | Source | Contents |
|---|---|---|
| Configuration keys | internal/config | Every YAML key with its environment variable, type, default and description |
| Metrics | registered Prometheus collectors | Name, type, labels and help of every metric served on /metrics |
| CLI commands | oa help | Every oa command with its usage |
| REST API | internal/api/openapi.json | Every endpoint per tag: parameters, request bodies, responses and schemas |
How-to pages that explain behaviour, with prose and examples: configuration, monitoring, CLI and REST API.