thermograph/docs/onboarding
emi 18f50ad09b
All checks were successful
secrets-guard / encrypted (push) Successful in 16s
shell-lint / shellcheck (push) Successful in 14s
Build + push images (Forgejo registry) / build-push (backend) (push) Successful in 1m24s
Build + push images (Forgejo registry) / build-push (frontend) (push) Successful in 1m23s
Deploy / deploy (backend) (push) Successful in 2m36s
Deploy / deploy (frontend) (push) Successful in 2m49s
frontend: fix the three inconsistencies the onboarding guide found (#99)
2026-07-25 21:27:44 +00:00
..
01-orientation.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
02-setup.md frontend: fix the three inconsistencies the onboarding guide found (#99) 2026-07-25 21:27:44 +00:00
03-repo-map.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
04-backend.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
05-frontend.md frontend: fix the three inconsistencies the onboarding guide found (#99) 2026-07-25 21:27:44 +00:00
06-contracts.md frontend: fix the three inconsistencies the onboarding guide found (#99) 2026-07-25 21:27:44 +00:00
07-ci-and-release.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
08-infra-secrets.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
09-observability.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
10-recipes.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00
11-traps.md frontend: fix the three inconsistencies the onboarding guide found (#99) 2026-07-25 21:27:44 +00:00
README.md docs: add a developer onboarding guide for the monorepo 2026-07-25 21:27:44 +00:00

Onboarding — becoming a full contributor to Thermograph

This is the developer onboarding path for the emi/thermograph monorepo: what the product is, how the code is shaped, how to run it, what will break silently if you get it wrong, and how a change actually travels from your editor to thermograph.org.

Scope. This covers working in this repo. Cross-cutting architecture decision records and operator runbooks live in the separate thermograph-docs repo (reachable through Centralis's docs_search) — this set links out rather than duplicating them. Where a fact is owned by a CLAUDE.md, that file stays the source of truth and this set explains the context around it.

Reading order

# Doc Read it when
1 Orientation First. What the product actually claims, the estate, the four non-negotiable rules.
2 Local setup Before you touch anything. Toolchain, verified run/test recipes for every service.
3 Repo map To find things. Every domain and directory, and which files matter.
4 Backend deep dive Before your first backend change. Data pipeline, grading, caching, roles, daemon.
5 Frontend deep dive Before your first frontend change. The Go SSR service, static assets, design system.
6 Cross-service contracts Before any change that touches both. These break silently and in production.
7 CI and release Before you open a PR. Nine workflows, three branches, three environments.
8 Infra and secrets Before you touch deploy, compose, or a secret.
9 Observability When something is wrong and you need to see it.
10 Recipes Task-shaped walkthroughs for the things you'll actually do.
11 Traps and stale docs Skim early, re-read often. Which docs in this repo currently lie, and why.

The short version

Thermograph grades how unusual today's weather is at any point on Earth against ~45 years of that exact location's own history. Percentiles, never thermometer readings.

  • backend/ — Python 3.12 / FastAPI. Owns all climate data, grading, the API, accounts, notifications, plus a Go daemon (backend/daemon/) that owns the Discord gateway and recurring timers. Ships as emi/thermograph/backend.
  • frontend/Go SSR service (frontend/server/) plus every static asset. No climate data, no database, no compute. Ships as emi/thermograph/frontend. (The Python implementation at frontend/*.py is the superseded original — see traps.)
  • infra/ — compose and Swarm files, deploy scripts, the SOPS secrets vault, Terraform, ops query tooling.
  • observability/ — Loki + Grafana on beta, an Alloy agent per node.

Branches stage environments: PR → dev (LAN dev) → main (beta) → release (prod). The two app domains build and deploy independently — that independence is the whole reason the split-then-reunify history exists, and contracts is the list of things that keep it safe.

Your first day

  1. Read Orientation and Traps.
  2. Work through Local setup until make test is green in both backend/ and frontend/server/.
  3. Read Repo map with the tree open beside it.
  4. Pick something small in the domain you're least afraid of, and follow Recipes end to end — including opening the PR.

Your first week

  • Read Contracts properly. Every item on that list has already cost someone a production incident somewhere in this project's history; that's why each one is written down.
  • Get Centralis wired up (see Local setup) and ask it fleet_status, logs_overview, deployed_version. You cannot debug this estate blind, and the boxes are not reachable from a laptop off the WireGuard mesh.
  • Read the CLAUDE.md for each domain. They are terse, current, and binding.