docs: the surfaces people actually land on were still selling the old project - #191
Merged
Merged
Conversation
… project
The README was rewritten yesterday. Four public surfaces that nobody looks at
while editing the README were not, and three of them are places people arrive
rather than places they are sent.
**GitHub Marketplace.** The listing is live at
marketplace/actions/mergewarden-for-ai-prs and its description comes straight
from action.yml, which still read "Checkout-free policy gate for AI-generated
pull requests". The name is left alone on purpose: the Marketplace slug is
derived from it, so renaming would orphan the existing URL for no gain.
**The npm page for `mergewarden`.** packages/cli/README.md is what npmjs.com
renders, and it was worse than stale:
- it told people to run `npx mergewarden@0.8.0`, two releases back
- it never mentioned `triage`, which is the reason 0.10.x exists
- it said "Authentication is optional for public repositories", which is the
exact claim corrected in the main README yesterday and which is false for
triage: 60 unauthenticated requests an hour does not cover one queue
Rewritten, and the exit codes are now stated per command because they differ.
`scan` and `replay` return 2 on an incomplete analysis (replay.ts:478); `triage`
returns 1, because a partly-read queue is still worth printing. The first draft
of this file merged the two and would have shipped a wrong claim to npm.
**The package description**, also rendered by npm, had the same old wording.
**docs/roadmap.md** stopped at "Shipped in v0.3.1" while the project is on
v0.10.2, so seven releases of work were invisible and the page read as a project
that stalled in spring. The Shipped section now describes what exists.
That file also already lists "A hosted SaaS, GitHub App, or built-in usage
telemetry" under Explicit Non-Goals, which settles the question of whether to
build a one-click App: it was decided and written down before today.
Deliberately unchanged: the old version strings in docs/demo-prs.md, which
record which build produced which verified external run, and would become false
if updated.
sjh9714
added a commit
that referenced
this pull request
Aug 6, 2026
…d project (#192) #191 fixed the copy on those two surfaces, and neither of them reads from the default branch. npm packages are immutable and the Marketplace listing takes its description from action.yml at the released tag, so the fixes were inert. Right now npmjs.com/package/mergewarden, on the version published an hour ago, opens with "MergeWarden is a checkout-free policy gate for AI-generated GitHub pull requests" and tells people to run: npx mergewarden@0.8.0 scan owner/repository#123 Two releases behind, no mention of triage, and the claim that authentication is optional for public repositories, which is false for triage. No behaviour changed. This exists so those pages stop lying. Verified in the order that has been working: `pnpm audit` with no severity filter before the tag, then the packed tarball rather than the source tree. Because the whole point is the packaged README, that file was read back out of the tarball: it opens with the new text, points at 0.10.3, and mentions triage.
sjh9714
added a commit
that referenced
this pull request
Aug 6, 2026
… said so (#194) #191 rewrote the action.yml description to match the new README. At 129 characters it exceeds the Marketplace limit of 125, so GitHub refused to publish v0.10.3 to the listing: Your action.yml needs changes before it can be published. Description must be less than 125 characters. The failure is silent from the repository's side. The release succeeds, npm updates, the tag is fine, and the Marketplace page simply keeps whatever description it had before. I checked the page afterwards, saw the old text, and guessed it was a cache. It was not. Shortened to 116 characters, keeping the two things that earn their place: the file names, which are the concrete hook, and that it closes nothing. A test now asserts the length, because this is not the kind of limit anyone remembers. Verified by reverting the long description and watching it fail.
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
1 participant
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.
The README was rewritten in #188. Four surfaces that nobody looks at while
editing the README were not, and three of them are places people arrive
rather than places they are sent.
GitHub Marketplace
The listing is live at
marketplace/actions/mergewarden-for-ai-prs, and itsdescription comes straight from
action.yml:The
nameis left alone on purpose. The Marketplace slug is derived from it, sorenaming orphans the existing URL for no gain.
The npm page for
mergewardenpackages/cli/README.mdis what npmjs.com renders. It was worse than stale:npx mergewarden@0.8.0, two releases backtriage, which is the reason 0.10.x exists at allcorrected in the main README yesterday, and false for
triage: 60unauthenticated requests an hour does not cover one queue
Rewritten. Exit codes are now stated per command, because they differ, and
the first draft of this file got that wrong:
scan,replay2(packages/cli/src/replay.ts:478)triage1, because a partly-read queue is still worth printingChecked against the source rather than carried over from the old text, which is
how the wrong version survived in there for two releases.
The package description
Also rendered by npm, same old wording.
docs/roadmap.md
Stopped at "Shipped in v0.3.1" while the project is on v0.10.2. Seven releases
were invisible and the page read as something that stalled in spring.
That file also already lists "A hosted SaaS, GitHub App, or built-in usage
telemetry" under Explicit Non-Goals, which settles a question raised today
about building a one-click App: it was decided and written down before this
conversation.
Deliberately unchanged
The old version strings in
docs/demo-prs.md. They record which build producedwhich verified external run and would become false if updated.
Verification
pnpm build && pnpm test && pnpm typecheck && pnpm lint && pnpm format:check,all green (461 tests), including the test asserting the root and package-local
action.ymlstay identical.