docs: rewrite action READMEs to be user-facing - #17
Merged
Conversation
…-internal Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ PR Validation Passed
📋 Pipeline Status
🤖 Generated by @helpers4 CI • 2026-07-29 |
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.
Summary
Per feedback on the published website preview (https://fix-website.helpers4.pages.dev/action/actions/setup-pnpm/): these READMEs read as internal helpers4 dev-notes ("collapses X duplicated across every helpers4 repo's CI") rather than descriptions written for someone deciding whether to use the action. A user landing on the Marketplace or website doesn't care whether/how helpers4 itself uses it — they care what it does for them.
Rewrote the opening description of the 3 affected actions to lead with capability, not origin story:
setup-pnpm: now opens with what it does (set up Node+pnpm in one step) and keeps the one fact that matters to a user (why not corepack — Node 26 drops it), dropping "duplicated across every helpers4 repo's CI"pr-status-comment: now opens with the actual value (one sticky comment instead of new ones piling up) instead of "collapses an 80-line block duplicated across every helpers4 repo"dispatch-with-fallback: rewritten description and both examples — swappedTRIGGANATOR_ID/PUSHINATOR_ID/action-release/helpers4/websitefor generic placeholder values (RELEASE_APP_ID,upstream-release,my-org/docs-site), and dropped the "onlytypescripthaving it" / "Fully generic, nothing assumes helpers4" meta-commentary — the input names (target-owner,target-repoboth required) already make the genericity obvious without saying soconventional-commits's README and the rootREADME.md's per-action blurbs were already user-facing — no changes needed there.One description, not two — same file serves GitHub and the website, so no ongoing duplication to maintain.
🤖 Generated with Claude Code