docs: prep README, examples, and metadata for launch - #12
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.
6 tasks
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
Who this is for,Examples,Privacy & security, andFAQsections; refresh the top navigation.examples/—digests/sample-quick.mdandsample-broad.mdfrom realpromote scanruns againsttrpc/trpc, plus illustrativepatches/*.patchdiffs, plus anexamples/README.mdindex with a "generate your own" snippet.SECURITY.md, paired with the private vulnerability reporting channel that's now enabled on the repo.Test plan
pnpm typecheck— passespnpm test— 51/51 passpnpm build— clean (193 KB ESM)#who-this-is-for,#examples,#privacy--security,#faq) and confirm it scrolls to the right sectionexamples/*links from the Examples section and confirm none 404SECURITY.md→ confirm the "Report a vulnerability" link opens GitHub's private advisory form