Repository navigation
[NO-TICKET] Say what the package is at the top of AGENT-INSTALL.md, and fix four inaccuracies - #353
Merged
Merged
Conversation
…nd fix four inaccuracies Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
Author
|
/review |
|
Clarifies package description and fixes credential environment variable names. 🎯 Quality: 98% Elite · 📦 Size: Small 🤖 Authorship: Agent-written — Claude Code, going by its own attribution. Whether a person read it is unknown; coding agents can call the 📈 This month: Your 172nd PR — above team average · Averaging Excellent |
patchstackdave
approved these changes
Oct 2, 2026
Resolve AGENT-INSTALL.md against setup's map upload: keep main's scan and setup wording, drop the package line now stated in the intro, keep the _site/ and indentation fixes, and say in the intro that setup and the prebuild hook upload the structural map. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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 opens with a short What this package is section: an npm package for JS/Node projects (not a WordPress plugin), MIT-licensed with its source on GitHub, published from GitHub Actions with npm provenance, how to check that withnpm viewandnpm audit signatures, and a short summary of what it does, with a link to the command reference. The summary names the runtime guard (protect) and says thatsetupand theprebuildhook upload a structural map of the server, never source text or environment values, whilemaprun on its own sends nothing without--upload.Four smaller corrections in the same file, and one in the CLI:
logintroubleshooting table said CI takes its credential fromPATCHSTACK_PULSE_AUTH. The Rules section and the CLI help both sayPATCHSTACK_API_KEY, andPATCHSTACK_PULSE_AUTHis only for a separate ingest credential. The table now saysPATCHSTACK_API_KEY. The CLI's "cannot run in CI" message insrc/cli.tssaid the same wrong thing and is aligned too.mark-buildoutput folders in "Package and command behavior" were missing_site/, whichBUILD_DIR_CANDIDATESincludes.prebuildline in the manualpackage.jsonexample was indented wrong.Why
AI coding tools have described this package as a WordPress plugin, or said it does not exist on npm. The facts that answer both were already in the doc, but at lines 89 and 107, after the setup steps. An agent auditing the tarball now reads who publishes it, where the source is, how to verify it, and what it does before any instruction to run something. The two old lines are removed so the facts are not stated twice. No reassurance wording is added.
The other fixes matter for the same reason: agents compare this doc with
dist/, and every mismatch costs trust.Verified
npm run typecheck: passes, including the template typecheck.npm test, after merging currentmain: 4275 passed, 7 skipped, 1 failed. The failure ismultipart-field-names.test.ts › grows linearly with the size of a part, a timing test that fails under full-suite load. It passes 22/22 in three isolated runs, and this PR does not touch the parser.npm run buildandnpm run capabilities:check:capabilities.jsonis up to date, with no vocabulary change.Outstanding gate
This file ships in the tarball, and the field-test fixture installs the published package, so a run before release would check the previous text. Run this immediately after the release that carries this change:
standardis the better check of doc accuracy. Until those runs, the disclosure tests andcapabilities:checkare what stand behind the change.Out of scope, worth a follow-up
This does not help with a refusal that happens before install. An agent that refuses at that point never reads this file, and the full install prompt is what addresses it. A field-test persona for that kind of refusal on a hosted AI builder belongs in its own PR.
Docs: this is the docs change.
README.md,GETTING-STARTED.mdand the install prompt are untouched.🤖 Generated with Claude Code