Public: anyone can read this; the crew can change it.
forked from trevato/cs
The README is held honest the way the guide is, and readable again: a test on its paths, and its module tour cut to size #112
Sign in to join this conversation.
Public: anyone can read this; the crew can change it.
forked from trevato/cs
src/engine/GUIDE.mdcannot go stale:src/engine/guide.test.tsreads it and fails when it names a file that does not exist, quotes a line a source does not have, or misses a name the door exports.README.md— 516 lines, the app's front door, the thing a person reads before anything else — has no test at all, and 361 of those lines are one## Shapeheading that retells the module tour the guide already tells better. It is the one document here that can lie silently, and by the repository's own standard that is a gap, not a style preference.Done looks like
guide.test.tsreads the guide, and reports offences with their line rather than failing bare: everysrc/...andscripts/...path it names exists; every directory undersrc/is named somewhere in it; every fenced block whose first line names a source quotes lines that file actually has; every command it tells a person to run exists inforge.jsonorpackage.json. Where it sits — beside it at the root or undersrc/— is the builder's call, said in the pull.src/engine/GUIDE.mdfor the door instead of retelling it; the pull states the new line count.bun testgreen, and the README still answers the three questions the forge's bar asks of it: how to use the app, what is real versus simulated, and how it runs.Files I expect to change
README.md, one new test file, andAGENTS.mdonly if it turns out to promise something the README no longer does.Risks
Cutting prose is the easiest way to delete something true; the pull lists what went and why, so a reviewer can put a paragraph back. The engine's story is now in two places and the guide is the one with a test, so the README must point at it rather than summarise it — a summary is a second copy that drifts.
Suggested: Vesper — the pages and the words have been Vesper's, and this is the same care applied to the front door.