docs: rewrite README with real output and correct facts; add launcher leaf README - #37
Merged
Merged
Conversation
… leaf README
Root README rewritten against verified facts:
- CI badge pointed at the wrong repo (claude-code-comment-checker) -- 404; fixed.
- Demo output was invented: claimed "(shares config, file, parse)" evidence
the binary does not print; replaced with verbatim output of a real run
against target/release/comment-checker (exit 2).
- "Releases triggered by tags pushed to main" described a flow that no
longer exists (release now runs off changesets merged to master) and
named the wrong branch; internal pipeline detail removed from the README
(dev content lives in AGENTS.md; user-facing release link only).
- Verified every claim in place: 37 languages (language.rs), F1 >= 0.85 /
60 cases (crates/comment-checker/tests/f1.rs + eval/corpus.json),
exit codes 0/2 (live run), --prompt + {{comments}} (main.rs), Rust 1.85+
(Cargo.toml), no-postinstall + platform optionalDependencies model.
- First screen per CLI shape: incumbent named, real tool output as demo,
install first, comparison table, exit-code contract, FAQ, monorepo map.
New leaf README for the launcher package: the registry product page npm
always packs into the published tarball. Monorepo routing: root maps,
leaf pitches, links up for license/contributing.
No changeset: README-only, no consumer-observable runtime change.
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
2 participants
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.
What
Root README rewritten from verified facts; new leaf README for the published npm launcher package.
Findings that motived this
claude-code-comment-checker— 404). Fixed tosystemfsoftware/comment-checker; both badges now resolve (checked via HTTP 200).restates what the code already says (shares config, file, parse); the binary prints no parenthetical. Replaced with verbatim output from a real run.main" neither names the branch (master) nor the flow (changesets → auto release PR). Pipeline internals removed per content routing; user-facing release link only.language.rs), F1 ≥ 0.85 on 60 cases (crates/comment-checker/tests/f1.rs,eval/corpus.json), exit codes 0/2 (live),--prompt+{{comments}}(main.rs), Rust 1.85+ (Cargo.toml), no-postinstall platform-optionalDependencies model.Shape
CLI + monorepo profile: incumbent named (flag-everything linters), real tool output as the hero demo, one primary install + ranked table, exit-code contract, comparison table, FAQ, repository map, contributing one-liner, license.
Scored with the skill gate: sections ✓, contributing ✓, prose density ✓, relative links ✓, tables ✓.
New file
npm/packages/comment-checker/README.md— the registry product page npm always packs regardless offiles; leaf links up to root for full docs, license, contributing.No changeset
README-only; nothing consumer-observable at runtime.