fix: point a new install at the map instead of at CI - #63
Merged
Merged
Conversation
Every documented route out of `init` ended in a CI round trip: commit, push, wait for the run, download the artifact, unzip it, serve the folder. The one command that puts the map on screen was listed only as a suggested package.json script, where nothing says it opens a viewer. So a person could install the tool, finish setup, and never once see the map it exists to draw. `init` now closes by naming that command on both paths — plain and `--github` — in both languages. It goes last deliberately: it is the only instruction that ends with something on screen, and the `--github` path otherwise signs off on a round trip through CI. The README (both languages) now opens its usage section with the same one command and links to it from the header. The Action keeps its section directly below, which is where it belongs: it answers "keep this current", not "show me the thing". Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Merged
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.
Closes the gap you flagged: a user installs, finishes setup, and never sees the map.
What was wrong
Every documented path out of
initended in a CI round trip:The command that opens the viewer in one step existed, but
initonly mentioned it as a suggested package.json script — where nothing tells you it opens anything:And the README filed it under "Local development: watch mode", below the Action it calls the "primary way to use". The strongest surface in the product was reachable only by reading past the section that told you to go to CI instead.
The fix
initnow closes by naming the command that ends with a map on screen — on both paths and in both languages. Actual output now:It is last on purpose: it is the only instruction that ends with something visible, and the
--githubpath otherwise signs off pointing at CI.The README (both languages) now opens its usage section with that one command and links to it from the header. The Action section stays immediately below — it answers "keep this current", not "show me the thing".
Evidence
The test fails without the fix. Three mutations were applied in turn, each had to turn it red, and the implementation was restored byte-identical after each:
build .instead ofwatch .(no viewer)Both paths run. Verified against real temp projects with the built CLI:
initunderLANG=zh_CN.UTF-8andinit --githubunderLANG=en_US.UTF-8— output above.No dead anchors. Renaming the Chinese section broke the header link to it (
#一次设置github-持续更新主路径). Every internal anchor in both READMEs is now checked by slug against every heading — 4 links, 4 resolve.docs/marketing/LAUNCH_KIT.mdpoints at the English anchor, which is unchanged.Full
npm run check: typecheck, 24 files / 214 tests (213 before, 1 new), build.Not in this PR
The Action's Step Summary already documents how to open
report.htmlfrom the artifact, and is honest that opening the file directly degrades to a static summary (file://blocks its ES modules). Making the Action surface the map without a download — e.g. a PR comment with affected features — is a product decision, not this fix.🤖 Generated with Claude Code