Skip to content

automaintainer: Improve supercli static documentation: README, CONTRIBUTING…#189

Merged
javimosch merged 1 commit into
masterfrom
am/am-f17c27-tg7zx6
Jun 6, 2026
Merged

automaintainer: Improve supercli static documentation: README, CONTRIBUTING…#189
javimosch merged 1 commit into
masterfrom
am/am-f17c27-tg7zx6

Conversation

@javimosch

@javimosch javimosch commented Jun 6, 2026

Copy link
Copy Markdown
Owner

Automated maintenance run by automaintainer.

Focus: Improve supercli static documentation: README, CONTRIBUTING, or docs/ files. Make ONE atomic commit with clear summary explaining what documentation was improved and WHY. Use fix:/docs: prefix. Keep it focused and reviewable.

Branch: am/am-f17c27-tg7zx6

Summary

Fixed stale documentation metrics and inconsistencies across 4 files: removed a duplicate npm test instruction in CONTRIBUTING.md, updated PLUGIN_STANDARDS.md phase completion stats to reflect the current 5,046 plugin count and 72-character average description length (down from the outdated 1,179 plugin and 105 short description counts), corrected package.json's tool count from 4,000+ to 5,000+ to match README, and removed an orphaned sentence in docs/plugins-how-to.md. These changes prevent contributor confusion from contradictory numbers and duplicated setup instructions.

Diff:

CONTRIBUTING.md        |  4 ----
 PLUGIN_STANDARDS.md    | 10 +++++-----
 docs/plugins-how-to.md |  2 --
 package.json           |  2 +-
 4 files changed, 6 insertions(+), 12 deletions(-)

Summary by CodeRabbit

  • Documentation

    • Streamlined development setup instructions by removing redundant test steps.
    • Updated plugin standards rollout progress and phase tracking.
    • Refined plugin creation getting-started documentation.
  • Chores

    • Updated platform description to reflect 5,000+ integrated tools (previously 4,000+).

- Remove duplicate npm test command in CONTRIBUTING.md setup section
- Update PLUGIN_STANDARDS.md phase completion metrics to reflect current
  plugin counts (5,046 plugins, 72 char avg description, 807 short remaining)
- Fix package.json description count from 4,000+ to 5,000+ to match README
- Remove orphaned sentence in docs/plugins-how-to.md between sections

These changes fix documentation that contains outdated numbers, duplicated
instructions, and inconsistent tool counts that could confuse contributors.
@javimosch javimosch merged commit 3da9117 into master Jun 6, 2026
1 check failed
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@javimosch javimosch deleted the am/am-f17c27-tg7zx6 branch June 6, 2026 17:22
@coderabbitai

coderabbitai Bot commented Jun 6, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 40ba4351-6d5a-44ab-9114-ba02886203e6

📥 Commits

Reviewing files that changed from the base of the PR and between c80b176 and e72372a.

📒 Files selected for processing (4)
  • CONTRIBUTING.md
  • PLUGIN_STANDARDS.md
  • docs/plugins-how-to.md
  • package.json

📝 Walkthrough

Walkthrough

This PR performs routine documentation and metadata maintenance across the project: consolidating development setup instructions by removing duplicate test commands, updating plugin standards progress tracking to reflect current phase status, simplifying the plugin guide introduction, and bumping the package description to reflect 5,000+ supported tools.

Changes

Documentation and Metadata Updates

Layer / File(s) Summary
Documentation and metadata cleanup
CONTRIBUTING.md, PLUGIN_STANDARDS.md, docs/plugins-how-to.md, package.json
Development setup instructions are consolidated by removing a duplicate "run tests" step and associated note; plugin standards progress tracking is updated for Phase 2 and Phase 3 status; plugin guide intro is simplified; and package description is updated from "4,000+ tools" to "5,000+ tools".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • javimosch/supercli#185: Updates README.md plugin count figures in parallel with this PR's package.json description bump and documentation maintenance.

Poem

📋 A rabbit hops through docs with care,
Tidying lines and updating there,
Five thousand tools now wear the crown,
Instructions cleaned and phases down,
Maintenance hops—the garden's bound! 🐰

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch am/am-f17c27-tg7zx6

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 and usage tips.

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