docs(readme): clarify claude and codex plugin installs#57
Conversation
Rename the README framing to Claude/Codex Plugins and split quick install guidance between Claude Code and Codex.
Reviewer's GuideUpdates the README to clarify that the repository provides a shared plugin collection for both Claude Code and Codex, and splits/expands installation instructions with explicit steps for each, including Codex marketplace file usage and workflow-skill wrappers. Flow diagram for Codex plugin installation via local marketplace fileflowchart TD
A[Start] --> B[Clone duyet/claude-plugins repository]
B --> C[Change directory to claude-plugins]
C --> D[Locate Codex marketplace file at .agents/plugins/marketplace.json]
D --> E[In Codex, add or import local marketplace.json]
E --> F[Duyet Claude and Codex Plugins marketplace appears in Codex]
F --> G[Browse available plugins and workflow skills]
G --> H[Install selected plugins from marketplace]
H --> I[Use installed plugins and skills in Codex]
I --> J[End]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
github-actions
Bot
added
the
documentation
|
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README was updated to explicitly position the project as a combined Claude Code and Codex plugin collection. The update includes expanded feature descriptions and separate installation workflows for Claude Code (using plugin marketplace CLI) and Codex (with local marketplace configuration and source mapping details). Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Welcome! 👋Thank you for your first contribution to this project! We appreciate you taking the time to improve our codebase. Next Steps
Contribution Guidelines
Thanks again for contributing! 🎉 |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README to include documentation and installation instructions for Codex, expanding the project's scope beyond Claude Code. It introduces a dedicated Codex section explaining how to use the local marketplace file and provides a JSON configuration example. A review comment correctly identified that the provided JSON example was missing mandatory 'category' and 'policy' fields required by the repository's validation scripts.
| { | ||
| "name": "github", | ||
| "source": { | ||
| "source": "local", | ||
| "path": "./github" | ||
| } | ||
| } |
There was a problem hiding this comment.
The example JSON for the Codex marketplace entry is missing the policy and category fields. According to the repository's validation script (scripts/validate-plugins.sh), these fields are required for all plugins in the Codex marketplace manifest. Adding them ensures the documentation provides a valid and complete example for users.
| { | |
| "name": "github", | |
| "source": { | |
| "source": "local", | |
| "path": "./github" | |
| } | |
| } | |
| { | |
| "name": "github", | |
| "source": { | |
| "source": "local", | |
| "path": "./github" | |
| }, | |
| "category": "Git", | |
| "policy": { | |
| "installation": "AVAILABLE", | |
| "authentication": "ON_USE" | |
| } | |
| } |
1 participant
Summary
Test Plan
Summary by Sourcery
Clarify documentation for installing and using the shared Claude/Codex plugin collection.
Documentation:
Summary by CodeRabbit