ETR Study API - Home page
Overview
This site is the engineering documentation for the ETR Study API.
Here you will find architecture notes, standards, onboarding guides, ADRs, runbooks, and auto-generated
Python
API docs (pdoc). If you host the repo on GitHub Pages with docs/ as the root, this page is the
docs
home.
⚠️ Docs changelog: Documentation changes are listed in docs/CHANGELOG.md. That
file
is separate from the root CHANGELOG.md, which tracks product and API releases.
Documentation index
| Topic | Link |
|---|---|
| Methodology | What ETR is, why it matters, how it works, and how to work with it. |
| Developers Docs |
Main entry: workflow, quality gates, policies, and links to hands-on guides under
docs/developer/ (requirements, contracts, Make, local dev, Docker image, docs pipeline).
|
| Make commands and workflows |
How to use make for setup, tests, deploy-related tasks, and day-to-day development. Tips
for
new contributors.
|
| Internal service documentation |
Engineering-focused behavior, business rules, and how operations map to HTTP — under
docs/internal/ (HTML). External clients use OpenAPI and the root changelog. Rules for who
reads what are in
ADR 0025 and
ADR 0026.
Open internal service documentation.
|
| How-to guides | Task-focused steps (for example auth setup, adding an endpoint, or working with the internal doc tree). |
| ADRs | Architecture Decision Records: why we chose a path, trade-offs, and context for big technical and process choices. |
| RFCs | Detailed specs and runbooks (for example docs search: index, rank, telemetry, storage, troubleshooting, KPI/SLO). |
| Architecture & quality assessments | Audits against common practice: scored tables, gaps, mitigations. See ADR 0024. |
| Runbooks | Steps for incidents and recovery: for on-call and anyone handling production issues. |
| Backlog | Prioritized features, bugs, and tech debt for planning and tracking work. |
| Python API reference | Generated from the Python code (pdoc): modules, functions, classes, docstrings, examples. |
| OpenAPI (test) | Swagger UI to explore and try the HTTP contract. For backend, frontend, and integrators. |
Repository root documentation
These Markdown files live next to the app code (not under docs/). Open them in your clone or on
GitHub at the repo root.
| File | What it covers |
|---|---|
README.md |
Overview, quick start, config, docs map, observability, Docker image (optional), repo tree, HTTP/OpenAPI links. |
CONTRIBUTING.md |
Quality gates, CI/CD and docs, dead-code checks, docs-fix / docs-check,
container image notes, OpenAPI updates, and what we expect from contributors.
|
Page history
| Date | Change | Author |
|---|---|---|
| Added Page history section (repository baseline). | Ivan Boyarkin |