Skip to content

docs: update README with accurate plugin information - #189

Merged
baleen37 merged 1 commit into
mainfrom
wip/add-command-name-aliases
Jan 27, 2026
Merged

docs: update README with accurate plugin information#189
baleen37 merged 1 commit into
mainfrom
wip/add-command-name-aliases

Conversation

@baleen37

@baleen37 baleen37 commented Jan 27, 2026

Copy link
Copy Markdown
Owner

Summary

  • Fix plugin names (My Workflow → me, proper lowercase)
  • Remove non-existent Git Guard commands (/install-git-guard, /uninstall-git-guard)
  • Add detailed me plugin documentation (8 commands, 1 agent, 7 skills)
  • Add Auto Updater usage (/update-all-plugins command)
  • Update project structure to reflect actual plugin directories
  • Add Version Management & Release section with Conventional Commits guide
  • Add Jira MCP Server Setup section
  • Add Component Types explanation
  • Add Pre-commit Hooks section

Test plan

  • Verified all plugin information against actual codebase
  • Removed non-existent commands
  • Added missing documentation for me plugin features

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Expanded README with comprehensive plugin catalog and updated naming conventions.
    • Added development procedures including version management and release guidelines.
    • Enhanced command metadata definitions for improved organization and discoverability.

✏️ Tip: You can customize this high-level summary in your review settings.

- Fix plugin names (My Workflow → me, proper lowercase)
- Remove non-existent Git Guard commands (/install-git-guard, /uninstall-git-guard)
- Add detailed me plugin documentation (8 commands, 1 agent, 7 skills)
- Add Auto Updater usage (/update-all-plugins command)
- Update project structure to reflect actual plugin directories
- Add Version Management & Release section with Conventional Commits guide
- Add Jira MCP Server Setup section
- Add Component Types explanation
- Add Pre-commit Hooks section
- Remove duplicate Testing section

Co-Authored-By: Claude <noreply@anthropic.com>
@baleen37
baleen37 enabled auto-merge (squash) January 27, 2026 03:38
@coderabbitai

coderabbitai Bot commented Jan 27, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation updated to reflect kebab-case plugin naming conventions and expanded plugin descriptions. Multiple command metadata files in the me plugin received YAML front matter additions introducing explicit name fields to standardize command identification across the plugin structure.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Plugin catalog restructured with kebab-case naming; plugin coverage expanded (ralph-loop, git-guard, me, jira, auto-updater, strategic-compact); Quick Start section updated; Project Structure reflects concrete plugin folders; version management and release procedures documented.
Me Plugin Commands Metadata
plugins/me/commands/brainstorm.md, plugins/me/commands/create-pr.md, plugins/me/commands/debug.md, plugins/me/commands/refactor-clean.md, plugins/me/commands/research.md, plugins/me/commands/sdd.md
Added YAML front matter name field to command metadata files for explicit command identification; existing fields (description, argument-hint, disable-model-invocation) preserved.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 A rabbit hops through plugin names so clean,
From caps to kebab, a naming dream!
Commands now labeled with pride and care,
Front-matter metadata floating fair,
Documentation blooms everywhere! ✨


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.

@baleen37
baleen37 merged commit 44b4d19 into main Jan 27, 2026
1 of 2 checks passed
@baleen37
baleen37 deleted the wip/add-command-name-aliases branch January 27, 2026 03:39
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