Repository navigation
docs: npm README as a front door for humans, agents and the npm index - #85
Merged
Merged
Conversation
Compresses the repository front door into the npm page: positioning line, hero, badges, a 30-second try block (7 lines, expected output on each, stranger-tested against the published 0.13.0 on Linux and macOS), how one decision flows, a harness table, a block for AI agents, a 5-question FAQ, and the wrapper's install, checksum and environment details last. package.json: tighter description, 20 keywords, homepage = the front door. No version 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
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.
The npm page today shows a 1,663-byte README with no image and nothing for agents. This rewrites
npm/README.md(10,111 bytes) as a compressed front door, built from the repository README's first sections. Every claim is true of the published 0.13.0.What the page has, in order: positioning line, hero, badges (CI, npm version, license) · "What it is, in 20 seconds" · "Install and try it in 30 seconds" (
npm install -g probbit, then 7 lines with the expected output on each) · the flow diagram + four sentences (normalise → program → exact solve or sample → gate → receipt) · "Use it from your harness" (MCP, OpenClaw plugin, Node, Python or any language, wasm, CI) · "For AI agents reading this" · FAQ (5) · the wrapper's own section (platforms, sha256,--ignore-scripts, the four environment variables, exit codes), now last.npm/package.json: description tightened (289 chars), keywords 15 → 20 (from the discoverability keyword table),homepage→ https://bitmapasset.github.io/probbit/. Version unchanged (0.13.0). The page reaches npmjs.com only with the next publish (0.13.1, after av0.13.1GitHub release, becauseinstall.jsfetchesv<package version>).Checks
</>outside code; 5 images, all HTTP 200image/*, PNG/JPG for the raw-GitHub ones (no.svgfrom raw GitHub, which serves it as text/plain); 19 links and command URLs, all 200 (npmjs.com answers 403 to curl, so the registry was checked: 200);npm pack --dry-runlistsREADME.md.HOME,npm install -g probbit@0.13.0into a temp prefix, every command of the try block and the harness table run line by line, extracted verbatim from the README. Linux x86_64: 12 PASS, 0 FAIL. macOS arm64: 12 PASS, 0 FAIL. Not run (3):claude mcp addandopenclaw plugins installchange a harness's configuration (probbit-stanceis checked on npm instead: 0.2.0), and the wasm build needs Rust. The test found one bug in the first draft:node decide.mjswith no argument reads a file that exists only in a clone. The harness row now passes its own router document.