gramps
b5e3dbe614
One file (AGENTS.md) that bootstraps the rest: rules, the file map to create, what belongs in each file, the first-session interview order, and the list of anti-patterns that killed the previous map (1,308-line guide, 63 task files, narrative history inline, sessions skimming 56k tokens of context). Separates four kinds of content by read frequency: rules/invariants -> AGENTS.md (every session) subsystem truth -> docs/ai/<topic>.md (only the matching one) lookups -> environment.md (grepped, never read) retired decisions -> decisions.md (only when re-opening one) Caps are enforced, not promised: scripts/verify.sh checks doc budgets before the build, so a commit that pads a capped file fails. Proven both ways — it passes clean and exits 1 on an over-cap file. scripts/scope-check.sh blocks edits outside the declared file list. templates/ holds fill-in skeletons for the seven files a project must create. CC0: copy it, rename it, sell it, no attribution needed.
31 lines
854 B
Markdown
31 lines
854 B
Markdown
# <Product> (repo `<name>`) — AI guide & router
|
|
|
|
> Read [`AGENTS.md`](AGENTS.md) first: the rules and the invariants. This file is the **map** —
|
|
> what the product is, how it is built, and where the truth lives. No narrative, no status.
|
|
|
|
## What it is
|
|
|
|
<Five lines max: what it does, for whom, the platform, the one thing that makes it different.>
|
|
|
|
## Build, run, test
|
|
|
|
<The commands actually used. Link to docs/ai/environment.md for the full runbook.>
|
|
|
|
## Architecture
|
|
|
|
| Path | Role |
|
|
|---|---|
|
|
| `<dir>/` | <one line> |
|
|
|
|
## Where the truth lives
|
|
|
|
| Subsystem | File | Read when |
|
|
|---|---|---|
|
|
| <subsystem> | [`docs/ai/<topic>.md`](docs/ai/<topic>.md) | <the trigger> |
|
|
|
|
Lookup, not reading: [`MyMistakes.md`](MyMistakes.md) · [`TASKS.md`](TASKS.md) · `<dir>/index.md`.
|
|
|
|
## Current state
|
|
|
|
[`HANDOFF.md`](HANDOFF.md) — do not restate it here.
|