turbo-editors/turbo-go · README.md

⑂ main

README.md · 23 lines · 1.9 KBmarkdown    Blame HistoryRaw
   1# `.memory/` — the project's durable record
3This folder is for whoever **continues building** turbo-go. It is committed to the repository, not gitignored: that is the whole point.
5Keep it apart from `docs/`. `docs/` is for whoever *uses* the editor; this is for whoever *works on it*.
7| File | What it is | How it is maintained |
8| --- | --- | --- |
9| `summary.md` | A **snapshot** of the project's current state: what it is, how it is built, what decisions are in force, what is not yet established. | **Edited in place.** Change only what a session establishes or invalidates; leave the rest byte for byte alone. Never regenerated wholesale. |
10| `history.md` | An **append-only** log, one dated entry per session. | **Only ever grows.** Never rewritten, never tidied up, never corrected after the fact. A history you edit is not a history. |
11| `handoffs/YYYY-MM-DD-slug.md` | What the next session needs to pick the work up: state, work in flight, next steps, blockers, traps. | One file per session and topic. Never overwrite someone else's. |
13## Reading it
15Start with `summary.md`, then the tail of `history.md`, then the most recent handoff. Between them they should answer "what is this, what state is it in, and what was the last person doing" without your having to read the code first.
17Do not ask the user for anything that is written here.
19## Writing it
21Match the length to the work — a one-line fix earns a few lines, not a filled-in template. Record what the next person **cannot re-derive**: where you stopped, what you tried that failed, the trap you hit, the decision still waiting on the user. Not a diff summary; git already has that.
23Anything you did not verify goes under `## Not yet established` in `summary.md`, stated as unknown. A summary that admits its gaps is useful; one that states guesses as fact is worse than none, because the next session will trust it.

📦 Turbo Go 3d7798b k33g 12h ago	1	# `.memory/` — the project's durable record
	2
	3	This folder is for whoever continues building turbo-go. It is committed to the repository, not gitignored: that is the whole point.
	4
	5	Keep it apart from `docs/`. `docs/` is for whoever uses the editor; this is for whoever works on it.
	6
	7	\| File \| What it is \| How it is maintained \|
	8	\| --- \| --- \| --- \|
	9	\| `summary.md` \| A snapshot of the project's current state: what it is, how it is built, what decisions are in force, what is not yet established. \| Edited in place. Change only what a session establishes or invalidates; leave the rest byte for byte alone. Never regenerated wholesale. \|
	10	\| `history.md` \| An append-only log, one dated entry per session. \| Only ever grows. Never rewritten, never tidied up, never corrected after the fact. A history you edit is not a history. \|
	11	\| `handoffs/YYYY-MM-DD-slug.md` \| What the next session needs to pick the work up: state, work in flight, next steps, blockers, traps. \| One file per session and topic. Never overwrite someone else's. \|
	12
	13	## Reading it
	14
	15	Start with `summary.md`, then the tail of `history.md`, then the most recent handoff. Between them they should answer "what is this, what state is it in, and what was the last person doing" without your having to read the code first.
	16
	17	Do not ask the user for anything that is written here.
	18
	19	## Writing it
	20
	21	Match the length to the work — a one-line fix earns a few lines, not a filled-in template. Record what the next person cannot re-derive: where you stopped, what you tried that failed, the trap you hit, the decision still waiting on the user. Not a diff summary; git already has that.
	22
	23	Anything you did not verify goes under `## Not yet established` in `summary.md`, stated as unknown. A summary that admits its gaps is useful; one that states guesses as fact is worse than none, because the next session will trust it.