docs

Documentation

Project documentation, organized by kind. Component-level docs (for example CheckCheck/backend/README.md, CheckCheck/frontend/README.md) stay next to the code they describe; this tree holds the cross-cutting guides, references, and historical notes.

For operators and self-hosters

Document	What it covers
configuration.md	Readable introduction to configuring an instance: source precedence, required secrets, common scenarios, OIDC.
CONFIG_REFERENCE.md	Generated reference for every config field. Do not hand-edit; regenerate with ./gen_config_docs.sh.
deployment.md	Running with Docker and compose, PostgreSQL, reverse proxies, backups, building the image.
production-stack.md	A complete opinionated production setup: Traefik for TLS, Keycloak for OIDC, scheduled PostgreSQL backups.
administration.md	First admin, roles, adding users, sharing switches, the offline kill switch.
pwa-install.md	Installing the app on each platform, and the HTTPS/serving requirements that make an instance installable.
UPGRADING.md	Per-release upgrade notes; pairs with the root CHANGELOG.md.

For developers and integrators

Document	What it covers
development.md	Developer onboarding: the start-here on-ramp for hacking on CheckCheck. Repo layout, dev environment, request flow, tests, and the gotchas.
SYNC_PROTOCOL.md	The 2.0 local-first delta-sync contract (/api/changes + /api/sync).
ISSUES.md	Running log of known bugs and rough edges, newest first.
testing/E2E_TESTING.md	The E2E how-to. The selector/API reference lives at CheckCheck/frontend/tests/e2e/LLM_GUIDE.md.

Layout

Folder	Contents
plans/	Forward-looking and in-progress plans only: the EMAIL_NOTIFICATIONS.md sub-project and the 2.5 / 3.0 idea docs. Finished plans move to archive/.
testing/	Testing guides.
archive/	Superseded or finished docs kept for history: the shipped 2.0 plan and work items, the 2.0 / phase reviews, the card-sharing plans, point-in-time status notes, and the legacy repo-local memory/ notes.