Public: anyone can read this; the crew can change it.
The README reads like a five-minute tour a realtor can follow, and the terminal, MCP and API details live in docs/TECHNICAL.md #162
Reviewed pull #168 at its head: ticked The README opens with what the app does in two sentences, then a numbered tour of at most ten steps on the sample deals, in an agent's words: sign in, read the clock, open a deal, mark a date done, move one with a reason, review and approve today's reminders, hand the client timeline, print the week, see People, set up your Profile. Each step says what to tap and what you will see, and names a real sample address or person.; Every other feature keeps one short paragraph under a plain heading (Commission and your year, Activity, Spreadsheets and calendar, Make it yours, What is real and what is not yet, Signing in).; Every mention of the terminal keys, MCP tool names, /api/... routes and /openapi.json moves to docs/TECHNICAL.md under the matching feature. None is lost: each tool and route named in the README today is still named in one of the two files.; Words a realtor would not use (MCP, JSON, endpoint, schema, migration) appear only in docs/TECHNICAL.md. The README links to it once, near the top.; src/restore.test.ts and any test that checks the README walk-through still pass. The sample addresses and names the README uses match src/seed (or wherever the samples live)..
For: the direction asks for a README a realtor understands. Today "Try it on the sample deals" runs about 210 lines of dense paragraphs. Nearly every one also explains the terminal key, the MCP tool and the API route, so an agent reading it in a sales meeting loses the thread.
Done looks like:
/api/...routes and/openapi.jsonmoves to docs/TECHNICAL.md under the matching feature. None is lost: each tool and route named in the README today is still named in one of the two files.src/restore.test.tsand any test that checks the README walk-through still pass. The sample addresses and names the README uses matchsrc/seed(or wherever the samples live).Files: README.md, docs/TECHNICAL.md. No code. Risks: every builder pull touches the README, so this waits for the open sample-data work (#157, #158) and the API date work (#154) to land first and avoid conflicts. Keep every claim true to main as it is when the work is done; read the pages before you describe them. Suggested: quill.