docs: fix stale README counts - #2944
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (1)
🧰 Additional context used📓 Path-based instructions (2)Lightweight agents with frequent invocation Pair programming and code generation Worker agents in multi-agent systems Main development work Orchestrating multi-agent workflows Complex coding tasks Complex architectural decisions Maximum rea...📄 CodeRabbit inference engine (.cursor/rules/common-performance.md) Files:
When working on README.md files, use the `/readme` skill.📄 CodeRabbit inference engine (CLAUDE.md) Files:
🔇 Additional comments (1)
📝 SummarySummary by CodeRabbit
WalkthroughThe README updates the command description and increases the documented skills count from 284 to 286. ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to The README now accurately describes the command directory and skill count, with no remaining merge-readiness risk. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ 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 |
|
|
Hey, thanks for catching this! Just so you know — we did check catalog.js before submitting, mainly to make sure this wouldn't break catalog:check. What we saw is that the validator regex treats commands and legacy command shims as equally valid — it's just an OR, not one term with the other as a fallback. Combined with the fact that commands is already what's used in the feature table and the directory tree elsewhere in the README, that felt like the more consistent choice, not just a guess. We didn't dig into the write-side sync function though, so good catch there. Since it always outputs legacy command shims no matter which one matched, that does look more like a bug in the writer than an intentional signal — especially given the read side treats both as equally fine. But if you actually want legacy command shims to be the standard going forward, totally happy to flip it back. Happy to fix the sync function too if that'd help — either preserve whatever term matched instead of hardcoding one, or update it to always emit commands to match the README, whichever you'd prefer. Just let me know which direction you want and I'll push it up. |
What Changed
Fixed two stale/incorrect facts in README.md:
skills/ # 284 reusable workflows loaded on demand— actual count is 286 (verified:find skills -name SKILL.md | wc -l→ 286, matching the two other "286 skills" mentions already in the README).commands/"legacy command shims" — they are not. The repo has a separate, genuinely legacylegacy-command-shims/commands/directory with only 12 files. Changed wording to "94 commands" to match the terminology already used in the feature table (| Commands | 94 commands | ... |) and to match scripts/ci/catalog.js's expected regex.Why This Change
Both numbers/wording were inconsistent with the actual repository contents and with other parts of the same README, which could confuse contributors trying to understand the skill/command surface.
Testing Done
node tests/run-all.js/npm test)Verified via:
find skills -maxdepth 1 -mindepth 1 -type d | wc -l # 286
find skills -mindepth 2 -maxdepth 2 -name SKILL.md | wc -l # 286
find commands -maxdepth 1 -type f | wc -l # 94
find legacy-command-shims/commands -maxdepth 1 -type f | wc -l # 12
npm test # all checks pass including catalog:check
Type of Change
docs:DocumentationSecurity & Quality Checklist
If you changed dependencies or package.json
N/A — no dependency or package.json changes.
If you added a skill, command, agent, hook, or CLI tool
N/A — no new skill/command/agent/hook added, only corrected existing counts in prose.
Documentation