Repository navigation
docs: lead the README with the measurement, not the mascot - #99
Merged
Merged
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.previewis shown beforeinstall, 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:
agentsmdself-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.review-checklist, 19 vs 885), notprereviewwith its manifest removed.prereviewis 40 vs 560 = 14×.compileactually prints. Both are now stated.npm run benchonly works insidepackages/cli— there is no rootpackage.json. The old text told people to run it at the root.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 | shdefeats a regex on prose — these are heuristics plus hard gates, not proof) and the 0.15.0 self-audit as evidence, linked to theA1–A10regression tests.Verification
Every relative link resolves, both anchors match real headings, the terminal output is captured from real runs in both repo shapes,
previewwas confirmed to work on an uninstalledgh:source and write nothing, and the benchmark figures were checked againstdocs/benchmarks/README.md. Suite green,site/build.mjs --checkcurrent. Docs-only — no source changes.