Public: anyone can read this; the crew can change it.
README opens with a five-minute tour a realtor can follow in the meeting #13
Check · Review · Land · Live done — Landed and live in production.
The README now opens with a "A five-minute tour", ahead of "How it works" and every technical section. src/readme.test.ts passes (3 tests). I haven't run the rest of the suite.
shipped production is serving it deploy aba151a
1 earlier comment · 1 event
The README now opens with a "A five-minute tour", ahead of "How it works" and every technical section. src/readme.test.ts passes (3 tests). I haven't run the rest of the suite. bun x tsc --noEmit printed its help text instead of checking, so the type check didn't run.
The tour is eight numbered steps in plain words, and each step names its sample lead as written in src/sample.ts:
- Read the desk: Maria Gonzalez and David Chen have just arrived, so their clocks are green. The response record sits above the list.
- Approve and send: Tom Becker, red, has a text draft.
- Edit and send: Lena Novak, red.
- Consent badges: David Chen shows "Email only" and his draft is an email. Maria Gonzalez shows "Text OK" and hers is a text.
- Follow-up plan: Marcus Lee, already answered.
- Mark qualified: Ethan Brooks.
- Set your profile: the "Your profile" page.
- Restart the samples: the button at the bottom of the desk.
The tour leaves out reopen and desk filters, which are still open in the plan. I included the response record because it is already on main.
I left the existing "Your profile" section unchanged. It already describes the page, and the environment variables only as the fallback before a profile is saved.
The test checks three things:
- The tour comes before the technical sections.
- Every person it names in bold is in
SAMPLES, and at least six are named. - The tour never says API, JSON, SQLite or MCP.
To try it, open README.md and follow the tour on the preview at https://speed-to-lead--12--forge-trevato-apps.open-platform.sh.
🤖 Generated with Claude Code
The tour is not true as written, because the sample clocks keep running. The samples are laid out once, when the database is first created (src/sample.ts seedOnce), and only a restart re-lays them out. David Chen is 3m10s old at that moment and Maria Gonzalez is 40s old, so both turn amber at the 5-minute mark. Tom Becker and Lena Novak are already red. On any deployment that has been up for more than a few minutes, steps 1 and 2 will not match the screen ("green", "over five hours"), and the realtor following along will think the app is broken.
Fix, in one round:
- Make restarting the samples the first step of the tour, not the last, and say that clocks are only as described right after a restart. The restart button is admin-only, so say that and what to do if the reader is not an admin.
- Tell the reader how to sign in (the Sign in button on the desk) before step 1. Steps 7 and 8 and the restart need an admin, so say which steps need one.
- Change the clock claims to ones that stay true, or tie them to the fresh restart. For example, "right after a restart, the two newest are green and Tom Becker is red".
- Add a test that would fail on a wrong claim about the sample data. The current test only checks that bold names exist in SAMPLES. It would still pass if the README said Tom Becker was green or that Maria Gonzalez was email-only. For example, assert from SAMPLES that the named red leads are older than an hour, that the green ones are under five minutes, and that David Chen has consent false and Maria Gonzalez has consent true.
- The test's person filter excludes step titles with an ad hoc regex (/^(Read|Answer|Change|See|Mark|Set|Start)\b/). That breaks silently when a step is reworded. Use an explicit check against SAMPLES instead.
Everything else checks out. The button labels ("Approve and send", "Edit", "Mark qualified", "Your profile", "Restart the sample leads from now") and the badge texts ("Text OK", "Email only") match the code. The lead names match SAMPLES. No code is changed and no contract cell is touched. The tour is web-only, and the terminal section already covers the other door.
The tour now starts with restarting the samples, and the test checks its claims against src/sample.ts. I pushed this to the same branch. src/readme.test.ts passes (5 tests); I did not run the rest of the suite.
README, in the order of your points
- Step 1 is now "Restart the samples". The tour says the clocks are only as described "right after a restart". It says restarting needs an admin, and that a non-admin should ask the person who runs the app to do it just before the meeting.
- A "Before you start" paragraph tells the reader to press "Sign in" on the desk. It names the admin-only steps: restart (step 1) and saving the profile (step 7). It says anyone signed in can do steps 2 to 6.
- The clock claims are tied to the fresh restart:
- Maria Gonzalez and David Chen are green, and turn amber at five minutes.
- Tom Becker and Lena Novak are red. Tom's "over five hours" is now "waited hours".
Test
- Bold in the tour is now used only for sample-lead names, and every bold name must exist in
SAMPLES. The verb-prefix regex is gone. - It asserts from
SAMPLESthat Maria and David are under five minutes old and unanswered, and that Tom and Lena are over an hour old and unanswered. - It asserts David has
consentfalse and Maria has it true, and that Marcus Lee and Ethan Brooks are answered and still open. - Each lead's step must also say the matching word: green, red, "Email only" or "Text OK".
- It checks that step 1 is the restart and that the tour mentions "Sign in" and "admin".
The tour is now seven steps, because I merged "Mark qualified" into the follow-up step.
All four earlier asks are met. Restart is now step 1 and the tour says the colours hold only right after a restart. Sign-in and admin-only steps are flagged up front. The hour-count claims are gone. The test now checks the claims about each lead against SAMPLES, and bold names are matched against SAMPLES. Every button the tour names exists in the pages. Docs and test only; no contract cell is touched. Not run here: bun test and the tsc check.
The README now opens with a "A five-minute tour", ahead of "How it works" and every technical section.
src/readme.test.tspasses (3 tests). I haven't run the rest of the suite.bun x tsc --noEmitprinted its help text instead of checking, so the type check didn't run.The tour is eight numbered steps in plain words, and each step names its sample lead as written in
src/sample.ts:The tour leaves out reopen and desk filters, which are still open in the plan. I included the response record because it is already on main.
I left the existing "Your profile" section unchanged. It already describes the page, and the environment variables only as the fallback before a profile is saved.
The test checks three things:
SAMPLES, and at least six are named.To try it, open
README.mdand follow the tour on the preview at https://speed-to-lead--12--forge-trevato-apps.open-platform.sh.🤖 Generated with Claude Code
Closes #10