Documentation

Everything we've written down about the project lives here. Documentation is our version of the Sharing principle from CALMS, the idea that a system nobody can explain isn't really maintainable, and knowledge locked in one person's head is a bottleneck waiting to happen. Pick the folder that matches what you're looking for.

---

Architecture

The shape of the system. The dependency graph maps out how services connected in the legacy app, and open-api lists every endpoint and contract.

---

Development

Getting your hands in the code. Branching strategy keeps us from stepping on each other, contributions walks through submitting changes, and init setup gets your local environment running.

---

DevOps

Moving code from laptops to production. CI/CD covers the pipeline, docker handles containers, devops-and-us explains the broader philosophy, and code review is about keeping quality high.

---

Database

Postgres migrations holds the schema history and the reasoning behind each change.

---

Testing

How we test lays out frameworks and expectations, while postman monitoring covers API validation in production.

---

Incidents

When things went sideways. The post-mortem is a full breakdown, python quirks and ruby quirks track known issues, and security breach documents what happened and how we responded.

---

Reports

KPIs track what's working, and mandatory-1 holds the compliance paperwork.

---

Reference

Useful links is a running collection of tools and resources worth bookmarking.

---

Ruby app

The Ruby app has its own docs: API docs, database config, and security.