Files
paperclip-harness/docs/DOCMAP.md

3.2 KiB

One home for each document

There is exactly one authoritative copy of every document. If you find a second copy, it is a pointer and should be deleted or replaced.

Document Where it lives What it is for
README.md project root where to start, what is installed, the rules
AGENTS.md project root instructions for the agent: what to build, which key, the first test
docs/OPERATING-RULES.md this project the nine rules that are not preferences: project convention, how a task is judged finished, approvals, secrets, cost
docs/TUIOS-RUNBOOK.md this project the environment is TUIOS not tmux: workspaces, panes, the machines, how sessions start, how to test an interface
HANDOVER.md project root where this is now: what exists, what was decided and why, what is unproven, and the note about the two earlier attempts
CHECKLIST.md project root the next session, step by step, with tick boxes
docs/OPERATING-RULES.md this project the nine rules: project folder, how work is judged, approvals, untrusted text, secrets, review and merge, one project per machine, cost, existing commands
docs/TUIOS-RUNBOOK.md this project how TUIOS works, the three machines, how to start a session, how to drive panes
docs/MOUSE-1-NOTES.md this project the decision model: how to call it, the cold start, and the four places it helps and the five it must not be used
docs/PLAN.md this project the plan: four screens, five milestones, who owns what
docs/ENVIRONMENT-FACTS.md this project ids, installed tools, the unproven heartbeat step
docs/PAPERCLIP-API-NOTES.md this project what we measured against the running Paperclip, with endpoints
docs/OPEN-ISSUES.md this project what is broken or unfinished in the closed project
docs/FALLBACK-OMA.md this project what OMA provides, kept in case the pivot is reversed
docs/WHAT-WE-ARE-BUILDING.md this project the person's own statement of the product
docs/UI-LAYOUT.md this project what each page must show, where each fact comes from, and the three candidate layouts
docs/PLAN-INTERFACE.md this project the plan: Paperclip object → screen, what exists, what is missing, and in what order
docs/SESSIONS.md this project the two kinds of session, where Pi's conversations are, and the plan for the junk TUIOS sessions
docs/TEST-PLAN.md this project the test plan: every step, every key, every expected result
docs/RUNS-AND-MERGE.md this project what a task, a run and a merge are, with the measured run counts
docs/NEXT.md this project what is left to build, in order, and what is still unproven

What is not a document of this project

~/paseo/projects/tuios_coding_harness and ~/paseo/harness are the closed second attempt. Their files now carry a banner saying this project holds the authoritative copy. They are kept for history only.

How a document changes

Edit the one copy named above, then commit. If something in the closed project turns out to be right, copy the content into the file named here — never create a second file that says the same thing in slightly different words.