Skip to content

docs: lead the README with the measurement, not the mascot - #99

Merged
singhharsh1708 merged 1 commit into
mainfrom
docs/readme-first-screen
Aug 7, 2026
Merged

singhharsh1708 merged 1 commit into
mainfrom
docs/readme-first-screen

Conversation

@singhharsh1708

Copy link
Copy Markdown
Owner

Why

GitHub traffic says the README is the entire funnel and it isn't converting: 13 unique visitors read the Overview; every other path got exactly 1 view. Nobody reaches the docs site, the releases, or the code. Meanwhile the one claim no competing tool can make — measuring a skill's standing token cost before you install it — was the fourth paragraph, below a 240px mascot, six badges, and two analogies ("like npm, like Docker, like ESLint") that place the project in a familiar category rather than apart from it.

Three drafts were written against different strategic angles (measurement-first, pain-first, trust-first) and scored by independent reviewers on skim-conversion, factual accuracy against this repo, and differentiation. Measurement-first won all three, and the best elements of the other two are grafted in.

What changed

The first screen is now: the claim, the commands, real compile output with the ℹ standing-cost line, then a heading that says why that line makes this a compiler rather than a converter. The status-quo-vs-kitbash diagram moves up under "Why not a sync script?" — the reader's actual objection, answered where they have it. preview is shown before install, since reading a stranger's skill before it touches your disk is a differentiator that was previously invisible above the fold.

Corrections found while restructuring

The pitch is honest measurement, so a wrong number in the pitch is a real bug. The review caught six:

  • The compile output was not real. The draft (and the framing of the old demo) implied a bare repo emits four files. It emits one — only agentsmd self-detects. The block is now output captured verbatim from an actual run, labelled with the repo shape that produces it, and keeps its trailing "7 more target(s) available" line.
  • 47× was misattributed. It is a separate unmanifested fixture (review-checklist, 19 vs 885), not prereview with its manifest removed. prereview is 40 vs 560 = 14×.
  • ~5,044 is the instruction body, not the standing cost. It compiles to ~5,101 standing on an eager target — the number compile actually prints. Both are now stated.
  • npm run bench only works inside packages/cli — there is no root package.json. The old text told people to run it at the root.
  • "The most-starred skill on GitHub ships twenty hand-maintained copies" — unsourced, with an unverifiable superlative and count. Replaced with the same argument stated without the unbacked specifics.
  • The diagram claimed "9 native outputs" per run. Compile emits per detected target.

Badges

Dropped GitHub stars and npm monthly downloads. Both actively mislead: downloads track publish-day mirror replication (every spike lands exactly on a publish date, decaying to zero between), and a single-digit star count is the first thing a skeptical reader anchors on. Kept npm version, CI, target count, license; added runtime_deps-0, which is a real and unusual property.

Trust section

The four hard-gate lints become a scannable table, followed by their documented limits stated plainly (c=curl; $c url | sh defeats a regex on prose — these are heuristics plus hard gates, not proof) and the 0.15.0 self-audit as evidence, linked to the A1–A10 regression tests.

Verification

Every relative link resolves, both anchors match real headings, the terminal output is captured from real runs in both repo shapes, preview was confirmed to work on an uninstalled gh: source and write nothing, and the benchmark figures were checked against docs/benchmarks/README.md. Suite green, site/build.mjs --check current. Docs-only — no source changes.

Traffic shows nearly every visitor reads the Overview and leaves: 13
unique readers of the README, 1 view each for every other path. The
differentiator — measuring a skill's standing token cost before install
— was the fourth paragraph, below a 240px mascot, six badges, and two
analogies that place the project in a category rather than apart from it.

First screen is now the claim, the commands, and real compile output
with the standing-cost line, followed by why that line makes this a
compiler rather than a converter. The status-quo diagram moves up to
answer the "why not a sync script?" reflex where the reader has it.

Corrections while restructuring, since the numbers are the whole pitch:
- the compile block is now output actually captured from a run, labelled
  with the repo shape that produces it, and keeps its trailing line; the
  previous framing implied a bare repo emits four files (it emits one)
- 47x is a separate unmanifested fixture (review-checklist, 19 vs 885),
  not prereview without its manifest
- ~5,044 is the instruction body; it compiles to ~5,101 standing on an
  eager target, which is what the tool prints
- `npm run bench` only resolves inside packages/cli — there is no root
  package.json
- dropped the unsourced "most-starred skill ships twenty copies" claim
- the diagram no longer says "9 native outputs" for every run; compile
  emits per detected target

Badges: dropped stars and monthly downloads. Both are misleading here —
downloads track publish-day mirror replication, and a star count is the
first thing a skeptical reader anchors on. Added runtime_deps-0.

Trust section: the four hard-gate lints become a table, with their
documented limits and the 0.15.0 self-audit as evidence.
@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
kitbash Ready Ready Preview Aug 7, 2026 12:52pm

@github-actions github-actions Bot added the documentation Docs, spec, RFCs, README, site label Aug 7, 2026
@singhharsh1708
singhharsh1708 merged commit 8927289 into main Aug 7, 2026
8 checks passed

This branch was successfully deployed

1 active deployment
Preview — 4f72ec90 Deployed Aug 7, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, spec, RFCs, README, site

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant