Repository navigation
README is describing a site that no longer exists: five false claims, including a count #2 already fixed once #34
Description
This is #2 again. That issue was "README documents a retired design system", and
the README has drifted back into describing a site that no longer exists. Five of
its claims are false on main today.
| README says | reality |
|---|---|
| "Five shipped developer tools" | seven, grep -c "^ name: '" lib/products.js |
"Colour tokens live in app/globals.css as RGB triplets" |
that file declares none, grep -c -- '--c-|rgb(' app/globals.css is 0 |
| "Bricolage Grotesque for headings" | gone since the design package 0.4.0; display and sans both resolve to var(--font-sans) in tailwind.config.ts:52 |
| "Amber on navy in the dark" | the accent is --wl-ring, oklch(0.6854 0.1699 252.99), a blue |
| "distribution strategy for us—it's" | an em dash, which the house rule puts at zero |
The tool count is the same failure lib/hero-count.test.js was written for after
#21 and #26: a number in prose goes stale the moment the shelf grows. The hero is
guarded and the README is not, so the count moved to the one place nothing checks.
Two things worth deciding rather than just rewriting:
- Whether the README should name a count at all. The hero's answer was no. The
same reasoning applies here. - Whether the type and colour paragraphs should describe the system at all, given
@weekndlabs/designis the source of truth and has its own docs at
design.weekndlabs.com. A link cannot go stale the way a copied palette does.
A test could pin the parts that stay: no digit-plus-"tools" in README.md, and no
em dash. Both are one regex each and would have caught four of the five rows.
Activity
docs(readme): describe the site that exists, and pin the two claims t…