Skip to content

Commit 8b25b7f

Browse files
javimoschSuperCLI Dev
andauthored
automaintainer: Improve supercli static documentation: README, CONTRIBUTING… (#191)
* docs: fix redundant minimal plugin structure in plugins-how-to.md The Minimal Plugin Structure section showed a flat layout (plugin.json + README.md at root) that contradicted the isolated plugin convention documented at the top of the same file. Replaced with the correct plugins/<name>/ directory layout including meta.json, and added cross-references to PLUGIN_STANDARDS.md and TAG_VOCABULARY.md for metadata guidance. Updated the Publishing section to match the required isolated structure. * docs: expand documentation index in CONTRIBUTING.md The 'Where to Find Documentation' section only listed 3 docs files and missed many key files (ROADMAP.md, PLUGIN_STANDARDS.md, AGENTS_FRIENDLY_TOOLS.md, server-plugins-usage-guide.md, feature-gaps.md, and the features/ directory). Contributors had no way to discover these resources without browsing the filesystem. Also improved the Documentation Style section with project-specific conventions. * docs: fix stale release badge date and add plugin count badge in README The release badge showed 2026-05-14 which is nearly a month old. Updated to current date (2026-06-07). Also added a plugins count badge (5000+) for better at-a-glance project context, consistent with the 5,000+ figure used throughout the README. --------- Co-authored-by: SuperCLI Dev <dev@supercli.dev>
1 parent 7f972f0 commit 8b25b7f

3 files changed

Lines changed: 37 additions & 17 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -198,18 +198,31 @@ docs(readme): update installation instructions
198198

199199
### Where to Find Documentation
200200

201-
- `/docs/` - Main documentation directory
202-
- `/docs/plugins-how-to.md` - Plugin development guide
203-
- `/docs/skills-catalog.md` - Skill document catalog and provider management
204-
- `/README.md` - Project overview and quick start
201+
- `/README.md` — Project overview and quick start
202+
- `/CONTRIBUTING.md` — This file
203+
- `/PLUGIN_STANDARDS.md` — Plugin quality standards (descriptions, tags, source URLs)
204+
- `/TAG_VOCABULARY.md` — Controlled vocabulary for plugin tags
205+
- `/ARCHITECTURE_PLAN.md` — Architecture plan and design decisions
206+
- `/docs/` — Main documentation directory
207+
- `/docs/plugins-how-to.md` — Plugin development guide
208+
- `/docs/skills-catalog.md` — Skill document catalog and provider management
209+
- `/docs/server-plugins-usage-guide.md` — Server plugin usage and testing guide
210+
- `/docs/AGENTS_FRIENDLY_TOOLS.md` — Agent-friendly CLI design principles
211+
- `/docs/ROADMAP.md` — Project roadmap (2026–2028)
212+
- `/docs/feature-gaps.md` — Feature gap analysis vs. capability-mesh vision
213+
- `/docs/plugins-available.md` — Available plugins listing
214+
- `/docs/plugins-examples.md` — Plugin examples
215+
- `/docs/features/` — Feature-specific documentation (adapters, skills, workflows, etc.)
205216
- Plugin-specific docs in `/plugins/*/README.md`
206217

207218
### Documentation Style
208219

209220
- Use clear, concise language
210-
- Include practical examples
211-
- Keep code snippets up to date
212-
- Use consistent formatting
221+
- Include practical examples with copy-pasteable commands
222+
- Keep code snippets up to date with current CLI syntax
223+
- Use consistent formatting: `backticks` for commands, **bold** for key concepts
224+
- Reference other docs files when relevant (e.g., "see [PLUGIN_STANDARDS.md](PLUGIN_STANDARDS.md)")
225+
- Plugin documentation must reflect the isolated file convention (never reference legacy shared files)
213226

214227
### Contributing Plugin Documentation
215228

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
<p align="center">
22
<img src="https://img.shields.io/npm/v/superacli" alt="npm">
3-
<img src="https://img.shields.io/badge/release-2026--05--14-blue" alt="Latest Release">
3+
<img src="https://img.shields.io/badge/release-2026--06--07-blue" alt="Latest Release">
44
<img src="https://img.shields.io/badge/license-MIT-green" alt="License">
5+
<img src="https://img.shields.io/badge/plugins-5000+-blueviolet" alt="Plugins">
56
<img src="https://img.shields.io/github/stars/javimosch/supercli?style=social" alt="Stars">
67
</p>
78

docs/plugins-how-to.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,16 @@ Every plugin harness consists of:
111111

112112
### Minimal Plugin Structure
113113

114+
Use the isolated plugin structure described at the top of this guide. Every file
115+
must live inside `plugins/<name>/` — never at the top level or in shared directories.
116+
114117
```
115-
my-plugin/
116-
├── plugin.json # Required: manifest
117-
├── README.md # Optional: plugin documentation
118-
└── examples/ # Optional: example usage
119-
└── example.sh
118+
plugins/my-plugin/
119+
├── plugin.json # Required: manifest with commands
120+
├── meta.json # Required: description, tags, has_learn
121+
├── install-guidance.json # Optional: install steps
122+
├── skills/quickstart/SKILL.md # Optional: agent guide
123+
└── README.md # Optional: human docs
120124
```
121125

122126
## plugin.json Manifest
@@ -157,9 +161,9 @@ The `plugin.json` file is the core of your harness. It describes:
157161
{
158162
"name": "beads", // Unique plugin identifier
159163
"version": "0.1.0", // Semantic versioning
160-
"description": "...", // Short description
164+
"description": "...", // Short description (30-150 chars, see PLUGIN_STANDARDS.md)
161165
"source": "https://...", // Link to upstream CLI
162-
"tags": ["task", "automation"], // Optional: discovery tags
166+
"tags": ["task", "automation"], // Optional: discovery tags (3-8 tags, see TAG_VOCABULARY.md)
163167
"author": "Your Name" // Optional: plugin author
164168
}
165169
```
@@ -433,8 +437,10 @@ Once your plugin is tested and working:
433437
2. **Structure it properly**:
434438
```
435439
my-plugin-harness/
436-
├── plugin.json
437-
├── meta.json
440+
├── plugin.json # Required: manifest with commands
441+
├── meta.json # Required: description, tags, has_learn
442+
├── install-guidance.json # Optional: install steps
443+
├── skills/quickstart/SKILL.md # Optional: agent guide
438444
├── README.md
439445
├── LICENSE
440446
└── examples/

0 commit comments

Comments
 (0)