[NO-TICKET] Point agents at setup first and describe the widget by claim state - #282
Merged
Merged
Conversation
The guide checklist on an unprovisioned project now leads with the two commands that cover every step (install, then setup) instead of only the individual steps. The docs now say the widget shows the "Connect this website" panel until the site is claimed, and the report button after. AGENT-INSTALL.md gains a short usual-path list and splits the hosted builder paragraph into steps. The install prompt is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Docs and CLI now clearly describe the widget state and prioritize setup first. 🎯 Quality: 100% Elite · 📦 Size: Small 📈 This month: Your 156th PR — above team average · Averaging Excellent |
Contributor
Author
|
/review |
daniloradovic
approved these changes
Sep 23, 2026
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.
What changed
guidechecklist: on a project that is not set up yet, the checklist now opens with the two commands that cover every step: install the package, thennpx @patchstack/connect setup. The individual steps are still listed below it, unchanged, and the new lines go away once the site is provisioned.AGENT-INSTALL.md,README.mdandGETTING-STARTED.mdno longer promise the "Report a vulnerability" button right after setup. They now say a site shows the "Connect this website" panel until it is claimed, and the button after.AGENT-INSTALL.mdreadability: a five-step "usual path" list near the top, and the long hosted-builder paragraph split into short steps plus a list of how each environment is labelled.Why agents were led off course
AGENT-INSTALL.mdtells agents to runguidefirst. On a fresh projectguidelisted six separate steps (runscan, hand-editpackage.jsonthree times, wire protection) and never mentionedsetup, which does all of them in one bounded command. An agent following the checklist assembled the install by hand.AGENT-INSTALL.mdstarted around line 90, and the hosted-builder instruction was one 1,700-character paragraph mixed with platform detection details.Fix
src/guide.ts: add a lead block whensiteUuidis null. It names the install command only when the package is not yet a runtime dependency. No existing checklist line changes.AGENT-INSTALL.md: add the usual-path list and split the paragraph. No content removed, so every capability is still disclosed.README.md,GETTING-STARTED.mdandfield-test/prompt.txt.Verified
npm test: 3255 passed, including 3 new tests for the checklist lead (shown when unprovisioned, install command omitted when already a dependency, gone once provisioned).npm run typecheck,npm run build,npm run capabilities:check: pass.guidefrom the built CLI on a fresh project and checked the new lead appears above the unchanged steps.Outstanding: these are
AGENT-INSTALL.mdandguideoutput changes, which the field test can only see once published. Runnode field-test/run.mjs --persona hostile --rounds 3, plus--persona standardfor doc accuracy, immediately after the release that carries this PR.Out of scope, worth a follow-up
The install prompt still says to refresh if the "Report a vulnerability" button is not showing, which is not what an unclaimed site shows. The docs now explain it, but fixing the prompt itself is a prompt change that needs a hostile field-test run before shipping, so it belongs in its own PR.
Docs: this PR is the docs change.
MAINTAINING.mdneeds no update.🤖 Generated with Claude Code