How to use the API is in the README; how to contribute is in CONTRIBUTING.md. These pages cover the rest.
| Page | Covers |
|---|---|
| architecture.md | How the service is built, how a request is handled, errors, and calls to PESU Academy |
| development.md | Setup, configuration, coding agents, code quality, documenting routes, adding errors and profile fields |
| testing.md | Test layout, running and writing tests, live tests, benchmarks |
| metrics.md | How /metrics collects its counters, what each means, protecting and scraping it, adding a metric |
| deployment.md | The environments, how changes are deployed, Docker images, monitoring |