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

Summary

Improved three documentation files to make the docs easier to navigate. docs/features/README.md now groups features by category (Core Engine, AI/Agent, Server, Domain) with a 'Choosing a Feature' lookup table. docs/plugins-how-to.md gained a 5-step validation checklist with copy-pasteable jq commands for manifest syntax, command definitions, binary deps, discovery, and smoke testing. CONTRIBUTING.md added an ASCII documentation cross-reference map showing how all docs relate to each other.

Diff:

CONTRIBUTING.md         | 32 +++++++++++++++++++++
 docs/features/README.md | 46 ++++++++++++++++++++++++++++++
 docs/plugins-how-to.md  | 74 ++++++++++++++++++++++++++++++++++++++++++++++---
 3 files changed, 148 insertions(+), 4 deletions(-)

Summary by CodeRabbit

• Documentation
  • Enhanced documentation navigation with a visual map of key documentation files and their relationships
  • Reorganized feature documentation into categorical sections with guidance to find relevant features by user needs
  • Expanded plugin validation guidance with a comprehensive step-by-step checklist covering manifest, commands, dependencies, and testing

[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: 72131d97-b1c0-4149-922f-94bd793c6ace

📥 Commits

Reviewing files that changed from the base of the PR and between aaba6e5 and 9be2e57.

📒 Files selected for processing (3)

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

---

📝 Walkthrough

Walkthrough

This PR adds structured documentation improvements across three core documents: a documentation map and cross-references in CONTRIBUTING.md, categorized feature links and selection guidance in docs/features/README.md, and a comprehensive plugin validation checklist in docs/plugins-how-to.md.

Changes

Documentation Navigation and Guidance

Layer / File(s)	Summary
Contributing Guidelines Documentation Map CONTRIBUTING.md	Adds a Documentation Map with directory-style overview of key documentation files and a Key relationships bullet list showing cross-references among documentation.
Feature Discovery and Selection Guidance docs/features/README.md	Adds "By Category" section grouping features into five labeled subsections (Core Engine, AI & Agent Integration, Server & Distribution, Domain Integrations, Multi-Step Automation) and a "Choosing a Feature" guidance table mapping user needs to recommended feature documentation links.
Plugin Validation Checklist Expansion docs/plugins-how-to.md	Replaces short validation instructions with a comprehensive "Validation Checklist" containing numbered steps for manifest syntax/field validation, command adapter configuration checks, binary dependency verification, plugin discovery/inspection, and execution smoke tests with concrete shell command examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• javimosch/supercli#189: Overlapping edits to CONTRIBUTING.md and docs/plugins-how-to.md; the related PR removes an intro line while this PR expands the validation checklist in the same document.

Poem

🐰 A map through the docs, categories bright,
Feature choices guided, plugin checks tight,
Navigation now clear, relationships shown—
The warren of wisdom, well-stocked and well-known! 📚✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

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

---

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.}