1.3 KiB
1.3 KiB
Index
What is in this collection, and what each document is for. Written in Simplified Technical English: short sentences, one idea each, no metaphor.
| Document | Read it when |
|---|---|
01-system-overview.md |
you need to know what the system is and how the parts fit |
02-config-and-env.md |
you need to run it, or find a setting, a path or a key |
03-code-map.md |
you need to change the code and want to know which file does what |
04-agent-runbook.md |
an agent is picking up this project and needs the rules and the traps |
Outside this collection:
| File | What it is |
|---|---|
AGENTS.md |
the first file an agent reads |
HANDOVER.md |
where the project is now, and why it is shaped this way |
docs/PLAN-INTERFACE.md |
the plan, and the measurements behind each decision |
docs/WORKSPACES.md |
every workspace and pane, with its status |
docs/RUNS-AND-MERGE.md |
what a task, a run and a merge are |
docs/TEST-PLAN.md |
every step of a manual test, with the keys |
docs/SESSIONS.md |
TUIOS sessions, Pi conversations, cleanup |
docs/PAPERCLIP-API-NOTES.md |
what the API actually returned |
docs/ENVIRONMENT-FACTS.md |
ids, machines, toolchain, fonts |
docs/NEXT.md |
what is left to build, and what is unproven |