How this repository is built, and the rules a change is held to. Product scope and feature design
live in docs/app/product/; one-off decisions and audits live in
docs/app/technical/.
| Document | Read it when |
|---|---|
| Architecture | You need the module graph, the dependency rules, or the ViewModel/data-layer/design-system shapes |
| Coding standards | Before writing code — conventions, state handling, and the reasoning behind them |
| Verification | You want to know what Spotless, Detekt, Lint and LeakCanary actually check, and what CI gates on |
| CI and release | You need to know what a workflow does, how a release is cut, or how it reaches production |
| AI workflow | You're working with a coding agent, or writing/updating an AGENTS.md or a skill |
The canonical, terse version of all of this is AGENTS.md — the file both humans
and agents are expected to read first. These documents expand it with reasoning and worked examples
from the codebase; where they disagree, AGENTS.md wins.
New here? Start with CONTRIBUTING.md for the workflow, then
architecture and coding standards.
Editing these docs? validateAgentContext checks Markdown links in AGENTS.md, CLAUDE.md,
SKILL.md and the root README.md, but not in docs/ — verify links here by hand.