[NO-TICKET] Tell the agent to report what the setup actually covered - #279
Merged
Merged
Conversation
The setup checklist marks the steps a project still owes, so a part it cannot carry, or one that is switched off, is a tick with nothing outstanding. A project can reach "0 steps remaining — Ready to deploy" with the widget off and no runtime guard, and an agent reading that reports a finished install. Add two paragraphs to Automated setup: remaining steps are work to finish, and a tick means "nothing owed here" rather than "this part is on", so the result is reported part by part with the inactive ones named. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
Author
|
/review |
|
Documentation now clearly reports what setup actually covered. 🎯 Quality: 97% Elite · 📦 Size: Tiny 📈 This month: Your 148th PR — above team average · Averaging Excellent |
daniloradovic
approved these changes
Sep 22, 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.
[NO-TICKET]
What changed
AGENT-INSTALL.mdnow tells the installing agent two things it did not say before: a step still on the checklist is work to finish, and a ✔ can mean "nothing owed here" rather than "this part is on". Docs only — no CLI or behaviour change.Why a finished-looking install can be a partial one
The checklist (
guide, and the copysetupprints) marks the steps a project still owes. A part the project cannot carry, or one that is switched off, is therefore green with nothing outstanding:No build script to integrate (postinstall covers dependency changes)Disclosure widget disabled by config ("widget": false in .patchstackrc.json)Runtime protection: not applicable — this project has no request pathAll three are ticks. A project reaches "0 step(s) remaining" and "Ready to deploy" with the widget switched off and no runtime guard —
tests/guide.test.tsalready pins that case. An agent summarising the checklist for someone who did not write the project reports "Patchstack is set up", which is true of the work owed and false of the coverage. Nothing in the shipped docs told it to read the ticks any other way.Fix
setupcan leave behind — moving the package out ofdevDependencies, the widget tag in a root layout it could not edit, the production marker on a server-rendered root, wiring a generic guard into the server entry — and points at Manual setup steps 3 and 4, rather than delegating to whatever the CLI prints."widget": falseas the one part that is off by a setting rather than by the shape of the project, so the agent raises it with the person instead of silently shipping without the widget.Verified
npm test(3252 passed, 7 skipped) andnpm run capabilities:checkare green. The three quoted checklist strings were copied from a realguiderun against a fixture, not from reading the renderer, so they match what an agent actually sees.The field test is outstanding, and this ships without it.
AGENT-INSTALL.mdis unpacked from the registry by the harness fixture, so a run against the current tarball would audit the previous text and say nothing about this change. It needs a run immediately after the release that carries it —standardorlovable, which install more reliably thanhostilewhen the question is document accuracy. Until then the local deterministic checks above are what stand behind it.Out of scope, worth a follow-up
The checklist still renders a reduced install as fully green. This change teaches the reader to interpret the output; it does not change the output. A helper in
src/guide.tscould name the inactive parts directly, both in the checklist and in the outcome block thatsetupasks the agent to relay as it is — which is the surface that survives summarising. That is a CLI change and deserves its own ticket.While looking: the outcome block's one related warning —
no build script, so only dependency installs are scanned— is gated on the build hook not having changed, so it fires only on a re-run and stays silent on the first one, which is the run whose output the agent relays. Worth folding into the same follow-up.Docs: this is the docs change.
🤖 Generated with Claude Code