Repository navigation
Rewrite the npm README as a user guide, not a build log - #62
Merged
Merged
Conversation
cli/README.md is what npmjs.com renders, but it had never been rewritten when the root README was — it was still the repo's original development log. Anyone landing on the package page got milestone status blocks (M1/M2/M3 PASS, per-milestone test counts), a dogfood post-mortem about jack-mcgovern.com, a file-by-file table of the repo's internals, and hand-run commands rooted at `node cli/*.mjs` that only work from a checkout. Its relative links (`../.mcp.json`, `../skill/`, `../docs/`) were all dead on npm. Cut all of it and rebuilt the page around what an installer needs: install + host matrix, the framework/ship matrix, upgrading, the loop, headless vs live with the full keymap, the preview == ship contract, and a CLI reference using the real `npx font-lab` surface. Every link is now an absolute GitHub URL so it resolves from the package page. Nothing was lost: the milestone history and dogfood findings already live in docs/DOGFOOD-REPORT.md and docs/RFC-ROLES-AND-COVERAGE.md, and the internals table is in CONTRIBUTING.md. Also corrected the stale "13 tools" claim (there are 26) and pointed the root README's description of this file at what it now contains. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012ecGYX4eJQzYQ96DuqvFLV
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.
cli/README.md is what npmjs.com renders, but it had never been rewritten
when the root README was — it was still the repo's original development
log. Anyone landing on the package page got milestone status blocks
(M1/M2/M3 PASS, per-milestone test counts), a dogfood post-mortem about
jack-mcgovern.com, a file-by-file table of the repo's internals, and
hand-run commands rooted at
node cli/*.mjsthat only work from acheckout. Its relative links (
../.mcp.json,../skill/,../docs/)were all dead on npm.
Cut all of it and rebuilt the page around what an installer needs:
install + host matrix, the framework/ship matrix, upgrading, the loop,
headless vs live with the full keymap, the preview == ship contract, and
a CLI reference using the real
npx font-labsurface. Every link is nowan absolute GitHub URL so it resolves from the package page.
Nothing was lost: the milestone history and dogfood findings already live
in docs/DOGFOOD-REPORT.md and docs/RFC-ROLES-AND-COVERAGE.md, and the
internals table is in CONTRIBUTING.md. Also corrected the stale "13 tools"
claim (there are 26) and pointed the root README's description of this
file at what it now contains.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_012ecGYX4eJQzYQ96DuqvFLV