Documentation
When two documents disagree, or a document disagrees with the code, the code and the generated contract win: api/openapiv1.json is written by the API itself and compared against it by the backend test suite (ADR-0053), so it is the one description whose drift from the code fails a test.
| Where | What |
|---|---|
adr/ | The decision records: why the system is the way it is |
api/ | The generated OpenAPI contract, and how to read it |
architecture/overview.md | How AzureBank works |
runbooks/ | What to do when the audit chain is unavailable, a PIN enrolment is repudiated, a refresh token's reuse is recorded, or a run of the demo pool ends with a signal |
testing/ | The public demo: how to try it by hand |
deferred/ | What was understood well enough to build and chosen not to, and why |
audit/ | A sample of the audit trail's exported anchor copy |
notices/ | The notices owed for a PIN enrolment or change, as rendered |
audit-trail-against-real-practice.md | The audit trail held against published practice |
engineering-practices.md | How this project is built and kept correct |
engineering-playbook.md | How the work is led: my role, the path of a change, the guards |
harness-engineering.md | What I build around the agents: the instructions, the checks and the limits, one pull request followed from start to finish, and what I have not measured |
engineering-traps.md | Things that fail silently or ship green: what goes wrong, why nothing reports it, and what to do |
brand-assets.md | Where every icon comes from |