Skip to content

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

Merged
javimosch merged 3 commits into
masterfrom
am/am-f17c27-tg5vou
Jun 5, 2026
Merged

automaintainer: Improve supercli static documentation: README, CONTRIBUTING…#187
javimosch merged 3 commits into
masterfrom
am/am-f17c27-tg5vou

Conversation

@javimosch

@javimosch javimosch commented Jun 5, 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-tg5vou

What Changed

455b26f1 docs: add server-plugins-usage-guide to features index
c3d8392a docs: replace confusing install example in README with practical workflow
350587a8 docs: clarify CONTRIBUTING prerequisites and plugin dev section

Diff:

CONTRIBUTING.md         | 12 +++++++++++-
 README.md               |  4 ++--
 docs/features/README.md |  1 +
 3 files changed, 14 insertions(+), 3 deletions(-)

Summary by CodeRabbit

  • Documentation
    • Updated quick-start command example in Node.js setup guide
    • Expanded contributor prerequisites and plugin development guidelines with structured directory layout examples
    • Added Server Plugins Usage Guide to feature documentation index

SuperCLI Dev added 3 commits June 5, 2026 13:52
Add bun to prerequisites (used by description enhancement pipeline scripts)
with note that it is optional. Expand plugin development section with the
isolated file convention directory tree and explicit warning not to edit
shared files — new contributors frequently miss this constraint.
…flow

The Node.js install section showed 'npx supercli uuid self generate' which
is a UUID utility command, not a useful first-run experience. Replace with
'skills list' which immediately demonstrates supercli's core value: querying
the 5000+ plugin catalog.
The server-plugins-usage-guide.md file exists in docs/ but was not linked
from the features index, making it undiscoverable for users browsing the
feature documentation. Add it to the feature index table.
@javimosch javimosch merged commit 4e7344c into master Jun 5, 2026
1 check failed
@javimosch javimosch deleted the am/am-f17c27-tg5vou branch June 5, 2026 13:53
@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.

@coderabbitai

coderabbitai Bot commented Jun 5, 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: 036575df-f16f-40a9-8c4a-ccbbe9829400

📥 Commits

Reviewing files that changed from the base of the PR and between e0f2277 and 455b26f.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • docs/features/README.md

📝 Walkthrough

Walkthrough

This PR updates documentation across three areas: contributor prerequisites and plugin development guidance in CONTRIBUTING.md, the user quick-start example command in README.md, and the feature documentation index in docs/features/README.md.

Changes

Documentation Updates

Layer / File(s) Summary
Contributor prerequisites and plugin development guidance
CONTRIBUTING.md
Bun is added as an optional prerequisite for description enhancement scripts. The Plugin Development section is expanded with explicit isolated file convention guidance and a structured plugins/my-plugin/ directory layout example.
User quick-start example command
README.md
Node.js quick-start example is updated from npx supercli uuid self generate to npx supercli skills list.
Feature documentation index
docs/features/README.md
Server Plugins Usage Guide is added to the Feature Index, linking to server-plugins-usage-guide documentation for manual testing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • javimosch/supercli#78: Implements the bundled-plugin directory structure under plugins/<name>/ that is now documented in this PR's CONTRIBUTING.md updates.

Poem

🐰 A hop through the docs, here and there,
Bun hops in, plugins laid bare,
Quick-start skills bloom where UUIDs were,
Features indexed with care,
Contributing paths crystal clear! 📚✨

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

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