Skip to content

docs: fix stale README counts - #2944

Open
NICKSTER0506 wants to merge 1 commit into
affaan-m:mainfrom
NICKSTER0506:docs/fix-readme-counts
Open

docs: fix stale README counts#2944
NICKSTER0506 wants to merge 1 commit into
affaan-m:mainfrom
NICKSTER0506:docs/fix-readme-counts

Conversation

@NICKSTER0506

Copy link
Copy Markdown

What Changed

Fixed two stale/incorrect facts in README.md:

  1. Directory tree comment said 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).
  2. Intro line called the 94 files in commands/ "legacy command shims" — they are not. The repo has a separate, genuinely legacy legacy-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

  • Manual testing completed
  • Automated tests pass locally (node tests/run-all.js / npm test)
  • Edge cases considered and tested

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: Documentation

Security & Quality Checklist

  • No secrets or API keys committed
  • JSON files validate cleanly (no JSON touched)
  • Shell scripts pass shellcheck (n/a — no shell scripts changed)
  • Pre-commit hooks pass locally (if configured)
  • No sensitive data exposed in logs or output
  • Follows conventional commits format

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

  • Updated relevant documentation (README.md)
  • Added comments for complex logic (n/a)
  • README updated

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 749afbe0-c76c-4ccf-90a5-b7b22940f8bd

📥 Commits

Reviewing files that changed from the base of the PR and between 22e8cf0 and 3f64a57.

📒 Files selected for processing (1)
  • README.md

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)
  • GitHub Check: Greptile Review
🧰 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:

  • README.md
When working on README.md files, use the `/readme` skill.

📄 CodeRabbit inference engine (CLAUDE.md)

Files:

  • README.md
🔇 Additional comments (1)
README.md (1)

165-165: LGTM!

Also applies to: 1077-1077


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the README to reflect the current command and skills counts.
    • Removed outdated “legacy” wording from the command count description.

Walkthrough

The README updates the command description and increases the documented skills count from 284 to 286.

Changes

README documentation

Layer / File(s) Summary
Update documented counts
README.md
The README now describes 94 commands without the “legacy” qualifier and documents 286 skills.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 3f64a

The README now accurately describes the command directory and skill count, with no remaining merge-readiness risk.

Suggested reviewers: haelyra

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the documentation change: correcting stale README counts.
Description check ✅ Passed The description directly explains both README corrections and provides supporting verification details. It is fully related to the changeset.
Docstring Coverage ✅ Passed 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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This README update changes the published catalog language to describe 286 skills and 94 commands. Running the catalog write command in an isolated copy changed that updated text back to “94 legacy command shims,” so the synchronizer needs to preserve the new terminology before this can merge.

Confidence Score: 4/5

Not safe to merge until catalog synchronization no longer overwrites the README’s updated command terminology.

The documented regression was reproduced by executing the real catalog write path in an isolated repository copy. The resulting README diff confirmed the user-facing wording is not stable under normal catalog maintenance.

Files Needing Attention: scripts/ci/catalog.js requires an update; README.md is the affected generated documentation surface.

T-Rex T-Rex Logs

What T-Rex did

  • T-Rex produced proofs for two posted P1 findings and attached them to the corresponding review comments.
  • T-Rex validated the catalog readme synchronization by running a reproducible exercise script, which reported a successful write (exit code 0) and matching catalog counts, while the README diff altered the suffix to legacy wording.

View all artifacts

T-Rex Ran code and verified through T-Rex

Comments Outside Diff (2)

  1. scripts/ci/catalog.js, line 383 (link)

    P1 Catalog synchronization restores stale command wording

    syncEnglishReadme accepts either commands or legacy command shims in the README summary, but its replacement always emits legacy command shims. Running node scripts/ci/catalog.js --write --text therefore changes the new line 165 wording back to the deprecated description. Preserve the intended commands label, or reuse the matched label, when writing the catalog counts.

    Artifacts

    README summary before catalog synchronization

    • A command captured README.md line 165 in the disposable copy before synchronization; it shows `94 commands`.

    Catalog write output and README summary after synchronization

    • The real catalog write command exited successfully and its captured diff shows README.md line 165 changed to `94 legacy command shims`, confirming the claim.

    Disposable catalog synchronization exercise script

    • The executed shell script copies the repository to a temporary directory, runs the real write path once, and writes the before and after command captures without changing the user checkout.

    View artifacts

    T-Rex Ran code and verified through T-Rex

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: scripts/ci/catalog.js
    Line: 383
    
    Comment:
    **Catalog synchronization restores stale command wording**
    
    `syncEnglishReadme` accepts either `commands` or `legacy command shims` in the README summary, but its replacement always emits `legacy command shims`. Running `node scripts/ci/catalog.js --write --text` therefore changes the new line 165 wording back to the deprecated description. Preserve the intended `commands` label, or reuse the matched label, when writing the catalog counts.
    
    ---
    
    For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
  2. General comment

    P1 Catalog write synchronization reverts README command wording

    • Bug
      • Running node scripts/ci/catalog.js --write --text against a temporary repository copy changed README.md line 165 from Access to 68 agents, 286 skills, and 94 commands... to Access to 68 agents, 286 skills, and 94 legacy command shims....
    • Cause
      • syncEnglishReadme matches either commands or legacy command shims but unconditionally emits legacy command shims in its replacement string at scripts/ci/catalog.js:381-383. The write loop invokes this synchronizer at scripts/ci/catalog.js:694-700.
    • Fix
      • Preserve the intended commands wording in the replacement (or capture and reuse the matched suffix) so catalog synchronization does not rewrite the updated README summary.

    T-Rex Ran code and verified through T-Rex

Prompt To Fix All With AI
### Issue 1
scripts/ci/catalog.js:383
**Catalog synchronization restores stale command wording**

`syncEnglishReadme` accepts either `commands` or `legacy command shims` in the README summary, but its replacement always emits `legacy command shims`. Running `node scripts/ci/catalog.js --write --text` therefore changes the new line 165 wording back to the deprecated description. Preserve the intended `commands` label, or reuse the matched label, when writing the catalog counts.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: fix stale README counts" | Re-trigger Greptile

@NICKSTER0506

Copy link
Copy Markdown
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant