fix: correct plugin marketplace source path and add documentation - #1353
Conversation
Fixes the marketplace.json source field to use the correct "./.claude-plugin" path instead of "." to resolve plugin installation errors. Also adds comprehensive plugin documentation to README explaining: - How to install the plugin in other repos (GitHub and local paths) - What slash commands are included - Plugin structure and principles **Error Fixed**: ``` Invalid schema: plugins.0.source: Invalid input: must start with "./" ``` **Changes**: - marketplace.json: source "." → "./.claude-plugin" - README.md: New "Claude Code Plugin" section with installation instructions
|
⏳ Code review in progress. Analyzing for code quality issues and best practices. Detailed findings will be posted upon completion. Using Amazon Q Developer for GitHubAmazon Q Developer1 is an AI-powered assistant that integrates directly into your GitHub workflow, enhancing your development process with intelligent features for code development, review, and transformation. Slash Commands
FeaturesAgentic Chat Code Review CustomizationYou can create project-specific rules for Amazon Q Developer to follow:
Example rule: FeedbackTo provide feedback on Amazon Q Developer, create an issue in the Amazon Q Developer public repository. For more detailed information, visit the Amazon Q for GitHub documentation. Footnotes
|
There was a problem hiding this comment.
Overall Assessment
This PR successfully addresses the plugin installation error and provides excellent documentation for the Claude Code plugin. The core fix is simple but essential - changing the marketplace.json source path from "." to "./.claude-plugin" resolves the schema validation issue.
Key Strengths
- Targeted Fix: The marketplace.json change directly addresses the reported installation error
- Comprehensive Documentation: The README additions provide clear installation instructions, command listings, and architectural context
- Design Philosophy: The principles section effectively communicates the "single source of truth" and provider-agnostic design approach
Minor Considerations
- Documentation Accuracy: The claim about "symlinked" commands should be clarified since the files appear to be copies rather than actual symlinks
- Maintenance Guidance: Consider adding information about how to keep the plugin commands synchronized with the knowledge base procedures
- Troubleshooting: Installation troubleshooting guidance would be helpful for users
The changes are well-structured and the documentation significantly improves the plugin's usability. This PR is ready to merge once the minor documentation accuracy issue is addressed.
| { | ||
| "name": "dotfiles-commands", | ||
| "source": ".", | ||
| "source": "./.claude-plugin", |
There was a problem hiding this comment.
Good fix! The change from "." to "./.claude-plugin" correctly addresses the schema validation error. This ensures the source path starts with "./" as required by the Claude Code plugin schema.
| ├── close-issue.md → ../../knowledge/procedures/close-issue-procedure.md | ||
| ├── create-issue.md → ../../knowledge/procedures/issue-creation-procedure.md | ||
| ├── extract-best-frame.md → ../../knowledge/procedures/extract-best-frame-procedure.md | ||
| └── retro.md → ../../knowledge/procedures/retro-procedure.md |
There was a problem hiding this comment.
The documentation structure is well-organized and comprehensive. However, there's a discrepancy between the documentation and the actual implementation. The documentation claims the commands are "symlinked" to the knowledge base, but examining the files shows they contain identical content rather than being actual symlinks. Consider updating the documentation to accurately reflect that these are copies or synchronized files rather than symlinks.
| # In any repo where you want these commands: | ||
| /plugin marketplace add atxtechbro/dotfiles | ||
| /plugin install dotfiles-commands@atxtechbro | ||
| ``` |
There was a problem hiding this comment.
The installation instructions are clear and provide both GitHub and local options. However, consider adding a troubleshooting section for common installation issues, such as what to do if the marketplace add command fails or if commands don't appear in autocomplete after installation.
|
|
||
| ``` | ||
| .claude-plugin/ | ||
| ├── plugin.json # Plugin metadata |
There was a problem hiding this comment.
The plugin structure diagram is helpful for understanding the organization. Consider adding version information or a note about how updates to the knowledge base procedures are synchronized with the plugin commands, since maintaining consistency between the two locations is critical for the "single source of truth" principle mentioned.
| **Principles**: | ||
| - Systems-stewardship: Single source of truth in knowledge base | ||
| - Dotfiles-as-plugin: Share your setup with other repos and users | ||
| - Provider-agnostic: Commands work identically across installations |
There was a problem hiding this comment.
The principles section effectively communicates the design philosophy. The "provider-agnostic" principle is particularly valuable for ensuring commands work consistently across different installation methods. This documentation will help users understand not just how to use the plugin, but why it's designed this way.
Summary
Fixes the plugin installation error by correcting the marketplace.json source path and adds comprehensive documentation.
The Problem
Plugin installation was failing with:
The
sourcefield in marketplace.json was set to"."but needs to start with"./"per Claude Code plugin schema requirements.What Changed
"."to"./.claude-plugin"Installation Instructions Now Documented
GitHub install (after this PR merges):
Local install (for testing):
/plugin marketplace add ~/ppv/pillars/dotfiles /plugin install dotfiles-commandsTest Plan
/plugin marketplace add ~/ppv/pillars/dotfilesFixes: Plugin installation errors from PR #1352