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 #168

Merged opened this

Check · Review · Land · Live done — Landed and live in production.

Merged

The README is now a ten-step tour of the sample deals, and every terminal key, tool name and /api/... route it used to mention is in docs/TECHNICAL.md. I only ran src/restore.test.ts (4 pass).

Notes

shipped production is serving it deploy d2eada7

opened this

The README is now a ten-step tour of the sample deals, and every terminal key, tool name and /api/... route it used to mention is in docs/TECHNICAL.md. I only ran src/restore.test.ts (4 pass). bun x tsc --noEmit printed only its usage text, so I don't count it as a pass. No code changed. I didn't run the gate script, and I didn't check the tour's steps in a running app. Step 3's sheet contents (who owes the date, the reminders for each party) are carried over from the old README text.

README.md

  • It opens with the two-sentence summary and one link to docs/TECHNICAL.md.
  • The tour has ten steps: sign in, read the clock, open a deal, mark a date done, move one with a reason, review and approve reminders, client timeline, print the week, People, Profile. Each says what to tap and what you'll see, and names a real sample address or person: 77 Harbor View Dr, 1418 Alder Lane, 9 Orchard Row, Priya Nair, Samuel Reyes, Maya and Tom Okafor. These match src/sample.ts.
  • Every other feature has one short paragraph under a plain heading:

- Finding a deal - Opening and shaping a deal - Commission and your year - Activity - Spreadsheets and calendar - Make it yours - What is real, and what is not yet - Signing in

  • I checked mechanically that every tool name, /api/... route and /openapi.json named in the old README is still in one of the two files.
  • Searching for MCP, JSON, endpoint, schema, migration, /api and openapi in the README finds nothing.

docs/TECHNICAL.md

  • A new section, "By feature: keys, tools and routes", lists the terminal keys, MCP tools, routes, status codes and the DEAL_CLOCK_* contract-length settings for each feature.

I left out some old README text:

  • The step-by-step detail of the old 16-step walk-through (for example, exactly what each reminder notice says) is gone.
  • I did not add the sample book-line text for the new samples, so the README's example line is shorter than what the app shows.

Merge order: the issue said to wait for #157, #158 and #154. I wrote against main as it stands, and main already includes #165, #167 and #160.

Closes #162

1 earlier comment · 1 event
commented

The README is now a ten-step tour of the sample deals, and every terminal key, tool name and /api/... route it used to mention is in docs/TECHNICAL.md. I only ran src/restore.test.ts (4 pass). bun x tsc --noEmit printed only its usage text, so I don't count it as a pass. No code changed. I didn't run the gate script, and I didn't check the tour's steps in a running app. Step 3's sheet contents (who owes the date, the reminders for each party) are carried over from the old README text.

README.md

  • It opens with the two-sentence summary and one link to docs/TECHNICAL.md.
  • The tour has ten steps: sign in, read the clock, open a deal, mark a date done, move one with a reason, review and approve reminders, client timeline, print the week, People, Profile. Each says what to tap and what you'll see, and names a real sample address or person: 77 Harbor View Dr, 1418 Alder Lane, 9 Orchard Row, Priya Nair, Samuel Reyes, Maya and Tom Okafor. These match src/sample.ts.
  • Every other feature has one short paragraph under a plain heading:

- Finding a deal - Opening and shaping a deal - Commission and your year - Activity - Spreadsheets and calendar - Make it yours - What is real, and what is not yet - Signing in

  • I checked mechanically that every tool name, /api/... route and /openapi.json named in the old README is still in one of the two files.
  • Searching for MCP, JSON, endpoint, schema, migration, /api and openapi in the README finds nothing.

docs/TECHNICAL.md

  • A new section, "By feature: keys, tools and routes", lists the terminal keys, MCP tools, routes, status codes and the DEAL_CLOCK_* contract-length settings for each feature.

I left out some old README text:

  • The step-by-step detail of the old 16-step walk-through (for example, exactly what each reminder notice says) is gone.
  • I did not add the sample book-line text for the new samples, so the README's example line is shorter than what the app shows.

Merge order: the issue said to wait for #157, #158 and #154. I wrote against main as it stands, and main already includes #165, #167 and #160.

Changes requested — before the latest push

Nothing is lost and no mutation or security surface changed (docs only). Two things to fix.

  1. Box 1: "Each step ... names a real sample address or person." Steps 1 (Sign in), 2 (Read the clock) and 8 (Print the week) name none. Fix first: name a sample in each, e.g. step 2 "the red marker on 77 Harbor View Dr and the amber one on 1418 Alder Lane", step 8 "the week includes the Harbor View inspection", step 1 "you land on the clock with 77 Harbor View Dr, Unit 4B ...".
  1. Box 1/step 2: the example book line ("4 open · $1,693,400 under contract · 3 closed this year") is shorter than what the app shows (it now also has the closed total, commission pending and earned this year). The builder says as much. Quote the line the app actually prints, from the preview, so the README matches what a realtor sees.

Also, box 4: make sure the README links to docs/TECHNICAL.md near the top (it does, once) and that "see the technical page" in Make it yours stays plain text, not a second link. Everything else (boxes 2, 3, 5 content: headings, tools/routes preserved in TECHNICAL.md, restore test unaffected) looks right.

commented

Both points from the review are fixed in README.md, and I pushed the change to the same branch. This round touches only the README; I did not re-run the tests.

  • Steps 1, 2 and 8 now name samples.

- Step 1 says you land on the clock with 77 Harbor View Dr, Unit 4B, 1418 Alder Lane, 9 Orchard Row and 2210 Juniper Court. - Step 2 names the red inspection marker on Harbor View and the grey earlier dates on Alder Lane. - Step 8 says the printed week starts with the overdue Harbor View inspection and includes the closing on Alder Lane.

  • Step 2 now quotes the full book line: "4 open · $1,693,400 under contract · 2 close in November · 3 closed this year, $1,375,000 · $45,328 commission pending · $37,395 earned this year". I did not read this from the preview, because I can't sign in there. I built it by running the app's own bookLine over freshly seeded sample deals. The "2 close in November" part follows the month you open the page, and the README says so.
  • Technical page link: the README links to docs/TECHNICAL.md once near the top. "See the technical page" in Make it yours is plain text, not a second link.
Approved

Earlier asks met: steps 1, 2 and 8 now name real samples, and the full book line is quoted. The README links to TECHNICAL.md once near the top, and the jargon words appear only in TECHNICAL.md. Every tool, route and key from the old README is named in the new TECHNICAL.md section. Docs only; no code or contract cell changed. The clone is on main, so I judged from the diff rather than a local diff since 70e4eed4abe3.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs