sam/paperclip-harness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finish the documents: one authoritative copy of each, listed in DOCMAP

Browse Source 
Docs consolidated: README, AGENTS, HANDOVER, CHECKLIST at the root; PLAN, DOCMAP,
ENVIRONMENT-FACTS, PAPERCLIP-API-NOTES, OPEN-ISSUES, FALLBACK-OMA, WHAT-WE-ARE-BUILDING
under docs/. DOCMAP names the one home for each. The closed project's copies now carry a
'Superseded' banner pointing here, so there are not two versions of anything.
This commit is contained in:
sam
2026-11-10 10:01:06 +11:00
parent 73c40fbdfe
commit b6f0cb572b
4 changed files with 68 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/DOCMAP.md Normal file
View File

@@ -0,0 +1,29 @@
# 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 |
| `HANDOVER.md` | project root | what we tried before, what worked, what failed, the pitfalls |
| `CHECKLIST.md` | project root | the next session, step by step, with tick boxes |
| `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 |
## 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.