docs: revamp README with comparison table, community tips, v3.2 updates#39
Merged
docs: revamp README with comparison table, community tips, v3.2 updates#39
Conversation
- Add competitor comparison table (vs Superpowers, ECC, gstack, GSD) - Add What's New in v3.2 section with all new features - Add Tips from the Community section with attributed quotes - Add Related Projects section - Update all counts: 24 skills, 8 agents, 21 commands, 24 hook events - Expand all tables with new skills, agents, commands, and hooks - Update structure section with correct counts
|
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughExpanded README to document v3.2: updated feature counts (skills, agents, commands, hook scripts/events), added a "What's New" v3.2 list (LLM Gates prompt type, Permission Tuner, Compact Guard, Cost Tracker, MCP Audit, Auto Setup, File Watcher, agent optimization flag), revised examples and new docs sections. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 345-356: The MD028 lint error is caused by blank lines between
consecutive blockquote lines in the "Tips from the Community" section; remove
the empty lines separating each blockquote so each >-prefixed line follows the
previous blockquote immediately (i.e., eliminate the blank lines between the
Andrej Karpathy and Boris Cherny quotes and between each subsequent Boris/Thariq
blockquote) to satisfy the Markdown rule.
- Around line 373-376: The two broken links in the Related Projects table (the
rows with link texts "everything-claude-code" and "claude-code-best-practice")
should be fixed: either remove those table rows or replace their URLs with the
correct repository paths (e.g., point them to the actual anthropics/claude-code
repo or another valid target) so they no longer 404; update the hrefs for the
link texts "everything-claude-code" and "claude-code-best-practice" in README.md
accordingly and ensure link text and URL refer to the same valid resource.
- Around line 94-107: Update the comparison table rows for gstack, ECC,
Superpowers, and GSD to avoid inaccurate exact counts: replace precise numbers
with verified ranges or "140+"/"60+" style summaries (e.g., change gstack Skills
from "33" to "18-23 skills" and Commands from "0" to a verified count/range
including listed slash commands; change ECC Skills/Commands to "140+ skills" and
"60+ slash commands"), and add inline citation links or footnote markers next to
those rows (attach sources for gstack and ECC) so readers can verify; modify the
table cells referencing "Skills" and "Commands" and the specific rows labeled
"gstack" and "ECC" (and mark Superpowers/GSD as "unverified" or use ranges)
rather than leaving exact unverified numbers.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+345
to
+356
| ## Tips from the Community | ||
|
|
||
| > "80% of my code is written by AI, 20% is spent reviewing and correcting it." — [Andrej Karpathy](https://x.com/karpathy/status/2015883857489522876) | ||
|
|
||
| > "Use subagents to throw more compute at a problem — offload tasks to keep your main context clean." — [Boris Cherny](https://x.com/bcherny/status/2017742755737555434) | ||
|
|
||
| > "If you do something more than once a day, turn it into a skill or command." — [Boris Cherny](https://x.com/bcherny/status/2017742748984742078) | ||
|
|
||
| > "Write detailed specs and reduce ambiguity before handing work off — the more specific you are, the better the output." — [Boris Cherny](https://x.com/bcherny/status/2017742752566632544) | ||
|
|
||
| > "Skill description field is a trigger, not a summary — write it for the model." — [Thariq Shihipar](https://x.com/trq212/status/2033949937936085378) | ||
|
|
There was a problem hiding this comment.
Fix blank lines between blockquotes.
Static analysis flags blank lines between the blockquotes (MD028). Remove the blank lines at 348, 350, 352, and 354 to comply with Markdown formatting standards.
📝 Proposed fix to remove blank lines
> "80% of my code is written by AI, 20% is spent reviewing and correcting it." — [Andrej Karpathy](https://x.com/karpathy/status/2015883857489522876)
-
> "Use subagents to throw more compute at a problem — offload tasks to keep your main context clean." — [Boris Cherny](https://x.com/bcherny/status/2017742755737555434)
-
> "If you do something more than once a day, turn it into a skill or command." — [Boris Cherny](https://x.com/bcherny/status/2017742748984742078)
-
> "Write detailed specs and reduce ambiguity before handing work off — the more specific you are, the better the output." — [Boris Cherny](https://x.com/bcherny/status/2017742752566632544)
-
> "Skill description field is a trigger, not a summary — write it for the model." — [Thariq Shihipar](https://x.com/trq212/status/2033949937936085378)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ## Tips from the Community | |
| > "80% of my code is written by AI, 20% is spent reviewing and correcting it." — [Andrej Karpathy](https://x.com/karpathy/status/2015883857489522876) | |
| > "Use subagents to throw more compute at a problem — offload tasks to keep your main context clean." — [Boris Cherny](https://x.com/bcherny/status/2017742755737555434) | |
| > "If you do something more than once a day, turn it into a skill or command." — [Boris Cherny](https://x.com/bcherny/status/2017742748984742078) | |
| > "Write detailed specs and reduce ambiguity before handing work off — the more specific you are, the better the output." — [Boris Cherny](https://x.com/bcherny/status/2017742752566632544) | |
| > "Skill description field is a trigger, not a summary — write it for the model." — [Thariq Shihipar](https://x.com/trq212/status/2033949937936085378) | |
| ## Tips from the Community | |
| > "80% of my code is written by AI, 20% is spent reviewing and correcting it." — [Andrej Karpathy](https://x.com/karpathy/status/2015883857489522876) | |
| > "Use subagents to throw more compute at a problem — offload tasks to keep your main context clean." — [Boris Cherny](https://x.com/bcherny/status/2017742755737555434) | |
| > "If you do something more than once a day, turn it into a skill or command." — [Boris Cherny](https://x.com/bcherny/status/2017742748984742078) | |
| > "Write detailed specs and reduce ambiguity before handing work off — the more specific you are, the better the output." — [Boris Cherny](https://x.com/bcherny/status/2017742752566632544) | |
| > "Skill description field is a trigger, not a summary — write it for the model." — [Thariq Shihipar](https://x.com/trq212/status/2033949937936085378) |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 348-348: Blank line inside blockquote
(MD028, no-blanks-blockquote)
[warning] 350-350: Blank line inside blockquote
(MD028, no-blanks-blockquote)
[warning] 352-352: Blank line inside blockquote
(MD028, no-blanks-blockquote)
[warning] 354-354: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 345 - 356, The MD028 lint error is caused by blank
lines between consecutive blockquote lines in the "Tips from the Community"
section; remove the empty lines separating each blockquote so each >-prefixed
line follows the previous blockquote immediately (i.e., eliminate the blank
lines between the Andrej Karpathy and Boris Cherny quotes and between each
subsequent Boris/Thariq blockquote) to satisfy the Markdown rule.
- Fix ECC link: anthropics/courses (404) → affaan-m/everything-claude-code - Fix best-practice link: anthropics/courses (404) → shanraisshan/claude-code-best-practice - Fix competitor counts: ECC 143→140+, 71→60+; gstack 33→18+, 0→5+ - Add source links to competitor names in comparison table header
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
Why
README needs to work as a standalone reference that people bookmark and star, not just a tool install guide. This brings it in line with top Claude Code ecosystem repos.
Test plan
Summary by CodeRabbit