automaintainer: Improve supercli static documentation: README, CONTRIBUTING…

[javimosch]

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-tgabna

Summary

Fixed documentation inconsistencies across three static docs files. plugins-how-to.md had a "Minimal Plugin Structure" section showing a flat layout that contradicted the isolated plugin convention documented 100 lines earlier — replaced with the correct directory layout and added cross-references to PLUGIN_STANDARDS.md and TAG_VOCABULARY.md. CONTRIBUTING.md's documentation index only listed 3 of ~15 docs files, making it impossible for contributors to discover ROADMAP.md, PLUGIN_STANDARDS.md, server-plugins-usage-guide.md, and others without browsing the filesystem. README.md had a stale release badge (2026-05-14) and lacked a plugin count badge for at-a-glance context.

Diff:

CONTRIBUTING.md        | 27 ++++++++++++++++++++-------
 README.md              |  3 ++-
 docs/plugins-how-to.md | 24 +++++++++++++++---------
 3 files changed, 37 insertions(+), 17 deletions(-)

Summary by CodeRabbit

• Documentation
  • Enhanced contribution guidelines with clearer documentation structure and stricter plugin documentation requirements.
  • Updated README badges, including new "5000+ Plugins" milestone indicator.
  • Improved plugin creation guide with explicit folder structure requirements and expanded metadata documentation.

[chatgpt-codex-connector]

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6ef5c169-2c84-4c43-80bb-679339d39d51

📥 Commits

Reviewing files that changed from the base of the PR and between 7f972f0 and 83636cf.

📒 Files selected for processing (3)

• CONTRIBUTING.md
• README.md
• docs/plugins-how-to.md

---

📝 Walkthrough

Walkthrough

This PR updates documentation to formalize the isolated plugin folder structure convention (plugins/<name>/) and strengthen contributor guidelines. Changes span plugin-how-to.md (minimal structure and publishing examples), CONTRIBUTING.md (documentation locations and style requirements), and README.md (release badge refresh).

Changes

Plugin Structure and Contributor Documentation

Layer / File(s)	Summary
Plugin folder structure and publishing examples docs/plugins-how-to.md	Established mandatory plugins/<name>/ folder layout with required plugin.json, meta.json, and optional install-guidance.json and skills/quickstart/ documentation. Updated inline field documentation for description, source, and tags in plugin metadata examples.
Contributor documentation requirements and style CONTRIBUTING.md	Expanded "Where to Find Documentation" with detailed paths (/docs/features/, plugin-specific READMEs) and added prescriptive "Documentation Style" rules requiring copy-pasteable commands, consistent formatting, and enforcing that plugin docs follow isolated file convention without legacy shared file references.
Release version and plugin count badges README.md	Updated "Latest Release" shield to 2026-06-07 and added "Plugins 5000+" milestone badge.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• javimosch/supercli#187: Both PRs enforce and document the isolated plugin folder structure convention (plugins/<name>/) with standardized file placement for plugin.json, meta.json, and optional plugin documentation.

Poem

🐰 Plugin folders now aligned,
Docs restructured, standards signed,
Five thousand strong, we celebrate,
Contributors guide the open gate! 📚✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch am/am-f17c27-tgabna

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}