Files
famapp/docs/tasks
ginnoir 6a1ec8bb7b docs: add professional readme with full feature coverage and release pipeline hook
Replaces the 8-line placeholder with a complete README covering all four
modules, platform capabilities, quick start, dev setup, configuration
reference, and deployment links. Badges use dynamic shields.io URLs so
version/CI status update automatically on each release.

Wires README review into the release pipeline via a release-it
before:git:release hook and a new item in the pre-deploy checklist.
2026-06-02 19:52:24 -05:00
..
2026-05-06 17:37:37 -05:00
2026-05-06 17:37:37 -05:00
2026-05-06 17:37:37 -05:00
2026-05-06 17:37:37 -05:00

Task briefs

Each file here is a self-contained brief for a sub-session (typically Sonnet) to execute one chunk of work. Briefs assume the executor has read /CLAUDE.md — do not restate the stack or architecture there.

How to use a brief

  1. Read /CLAUDE.md first.
  2. Read the task file end-to-end.
  3. Stop when all acceptance criteria pass. Do not bolt on extra scope.
  4. If a brief turns out to be wrong, update the brief in the same commit as the code.

Brief format

Every task file has these sections:

  • Goal — one sentence.
  • Why — what this unlocks; how it fits the larger plan.
  • Depends on — task numbers that must be done first.
  • Scope — bullet list of what to build.
  • Out of scope — explicit non-goals to prevent drift.
  • Acceptance criteria — checkable list. Done = all checked.
  • Notes — gotchas, recommended libs, sketches.

Phase index

Phase 1 — Scaffold

Phase 2 — Core modules

Phase 3 — Dashboard & UX

Phase 4 — Sharing

Phase 5 — Notifications & reminders

Phase 6 — PWA polish

Phase 7 — Hardening