These docs are written for GitHub readers. Backstage and TechDocs are intentionally out of scope for this repository.
| Page | Type | Use it when |
|---|---|---|
| Configuration Reference | Reference | You need exact app settings, stampbot.toml keys, GitHub App permissions, defaults, and failure behavior. |
| Operations and Troubleshooting | Runbook | A webhook, approval, ChatOps command, deployment, metric, or GitHub permission is failing. |
| Interface Reference | Reference | You need HTTP routes, webhook inputs, outputs, metrics, and external interfaces. |
| Cloud Run Deployment | How-to | You deploy Stampbot to Google Cloud Run with GitHub Actions. |
| Architecture | Explanation | You need the request flow, component boundaries, trust boundaries, and outputs. |
| Security Requirements | Explanation | You need the security properties Stampbot is expected to preserve. |
| Release Verification | How-to/reference | You verify release assets, SBOMs, VEX, SLSA provenance, chart packages, or container attestations. |
| Google Python Style Guide | External reference | Vendored style-guide copy synchronized by workflow; not Stampbot product documentation. |
For installation paths, start with the root README or INSTALLATION.md. For the Helm chart as an installable package, see charts/stampbot/README.md.