docs: pre-HN cleanup and prep 0.7.1 release - #13
Merged
Conversation
- Rewrite hero copy to lead with what promote-cli writes (CLAUDE.md, AGENTS.md, Copilot, Cursor, ADRs, tests) and what it isn't (yet another AI reviewer). - Add "Who this is for" so readers can self-select in/out. - Add Examples, Privacy & security, and FAQ sections that consolidate trust signals previously scattered across the README. - Refresh top navigation to surface the new anchors.
- examples/digests/sample-quick.md — OpenAI quick run (24 candidates, $0.07, 2m 14s) with three representative candidates and full evidence trails. - examples/digests/sample-broad.md — Anthropic broad run (17 candidates, $0.45, 4m 55s) showing convention-level patterns the quick mode misses. - examples/patches/claude-rule.patch — illustrative CLAUDE.md diff for an internal-API-boundaries rule. - examples/patches/cursor-rule.patch — illustrative .cursor/rules/*.mdc new-file diff. - examples/README.md — folder index with suggested reading order and how to generate your own digest.
- Expand package.json keywords from 6 to 15 (add ai-review, github, github-actions, pull-request, claude-code, copilot-instructions, cursor, adr, cli) so the npm listing is discoverable by people searching for any of the AI tool ecosystems promote-cli targets. - Add SECURITY.md with supported versions, the private vulnerability reporting channel (now enabled on the repo), and scope.
The cost table in README and docs/clustering.md still cited an older
benchmark (21 candidates, $0.47, 8m 17s) while the actual sample digest
shipped at 17 candidates, $0.45, 4m 55s. Anyone reading both pages would
hit an inconsistency in the first minute.
Make the sample digest the source of truth and update the table rows and
follow-up copy ("without the full depth …") to match. Also fix the
"Human signal" line on sample-broad Candidate 2: the data shows one
agreeing reviewer (@orbisai0security), not three.
The README now links to examples/digests/*, examples/patches/*, docs/config.md, docs/clustering.md, and SECURITY.md. Those links render fine on GitHub but break on the npm package page because relative paths resolve inside the tarball — and the tarball previously only shipped dist/. Expand the files allowlist so npm renders the same README the GitHub landing page does.
…st, within-PR note)
- README "Why" closing sentence reads cleanly now ("The decision is
still yours: whether and where each pattern belongs") instead of the
awkward original phrasing.
- README Examples intro now says "representative output from real scans"
so visitors don't expect full digests in the sample files.
- examples/github-actions/README.md previously said scans cost "a
handful of dollars" on default Claude models, which clashes with the
README's cents-to-cents-or-low-dollars framing. Reword to match.
- sample-quick Candidate 2 is within-PR, which can read oddly without
context. Add a one-line note explaining why within-PR patterns can
still surface even though they don't yet justify a repo-wide rule.
docs/prd.md is the internal product spec — it isn't user-facing and shouldn't ship in the npm tarball or be browsable on the public repo going forward. - Remove it from the working tree. - Add it to .gitignore so a local copy can stay on disk without being re-added. The file still exists in git history; scrubbing it from history is a separate, destructive operation (force-push of main) and not done here.
Tells release-please to bump to 0.7.1 on the next workflow dispatch. None of the changes since 0.7.0 are feat/fix/perf, so the action wouldn't open a Release PR on its own — this marker is the override. Release-As: 0.7.1
gyulsbox
force-pushed
the
docs/launch-cleanup
branch
from
May 23, 2026 13:19
efd7703 to
efb2866
Compare
gyulsbox
added a commit
that referenced
this pull request
May 23, 2026
docs: pre-HN cleanup and prep 0.7.1 release
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.
Summary
Pre-HN cleanup that stacks on top of #12 and prepares the 0.7.1 release. Five commits:
docs: align Anthropic broad numbers across README, docs, and examples— README anddocs/clustering.mdstill cited the older benchmark (21 candidates, $0.47, 8m 17s) whileexamples/digests/sample-broad.mdshipped at 17/$0.45/4m 55s. Anyone reading both pages would hit an inconsistency in the first minute. Make the sample the source of truth.fix(npm): include docs, examples, and SECURITY.md in published tarball— the README now links toexamples/digests/*,examples/patches/*,docs/config.md,docs/clustering.md, andSECURITY.md. These render on GitHub but break on the npm package page because relative paths resolve inside the tarball. Expand thefilesallowlist.docs: tighten launch copy (Why wording, Examples intro, GH Actions cost, within-PR note)— fix the awkward "The decision still yours is where it belongs" sentence; clarify Examples intro ("representative output from real scans"); replaceexamples/github-actions/README.md's "a handful of dollars" with the cents-to-low-dollars framing the rest of the README uses; add a one-linewithin-PRexplainer onsample-quickCandidate 2.chore: stop tracking docs/prd.md (internal-only PRD)— remove the internal PRD from the working tree and add it to.gitignoreso it doesn't ship to npm or stay visible on the public repo going forward. The file still exists in git history; scrubbing it from history is a separate destructive operation (force-push ofmain) and intentionally not done here.chore(release): cut 0.7.1 with launch-prep docs— empty commit withRelease-As: 0.7.1footer so release-please opens a Release PR on the next workflow dispatch. Without this, nothing in docs: prep README, examples, and metadata for launch #12 or this PR has afeat/fix/perftype, so release-please wouldn't bump on its own.After this PR and #12 both merge, the next two Release workflow dispatches will (1) open and merge the Release PR, then (2) publish 0.7.1 to npm.
Test plan
pnpm typecheck— passespnpm test— 51/51 passpnpm build— clean (193 KB ESM)npm pack --dry-run— tarball includesSECURITY.md,docs/clustering.md,docs/config.md, allexamples/*files; does not includedocs/prd.mdReleaseworkflow → expect a Release PR titledchore(main): release 0.7.1Out of scope
docs/prd.mdfrom git history. Requiresgit filter-repo+ force-push ofmain. Destructive; not done in this PR. If wanted, do it as a separate, coordinated step.