Skip to content

fix: correct plugin marketplace source path and add documentation - #1353

Merged
atxtechbro merged 2 commits into
mainfrom
fix/plugin-marketplace-source
Oct 9, 2025
Merged

fix: correct plugin marketplace source path and add documentation#1353
atxtechbro merged 2 commits into
mainfrom
fix/plugin-marketplace-source

Conversation

@atxtechbro

Copy link
Copy Markdown
Owner

Summary

Fixes the plugin installation error by correcting the marketplace.json source path and adds comprehensive documentation.

The Problem

Plugin installation was failing with:

Invalid schema: plugins.0.source: Invalid input: must start with "./"

The source field in marketplace.json was set to "." but needs to start with "./" per Claude Code plugin schema requirements.

What Changed

  1. marketplace.json: Changed source from "." to "./.claude-plugin"
  2. README.md: Added new "Claude Code Plugin" section with:
    • Installation instructions (GitHub and local paths)
    • List of included slash commands
    • Plugin structure diagram
    • Principles and design rationale

Installation Instructions Now Documented

GitHub install (after this PR merges):

/plugin marketplace add atxtechbro/dotfiles
/plugin install dotfiles-commands@atxtechbro

Local install (for testing):

/plugin marketplace add ~/ppv/pillars/dotfiles
/plugin install dotfiles-commands

Test Plan

  • Fix marketplace.json source path
  • Add plugin documentation to README
  • Test local installation: /plugin marketplace add ~/ppv/pillars/dotfiles
  • Verify commands appear in autocomplete after install

Fixes: Plugin installation errors from PR #1352

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
@amazon-q-developer

Copy link
Copy Markdown
Contributor

Code review in progress. Analyzing for code quality issues and best practices. Detailed findings will be posted upon completion.

Using Amazon Q Developer for GitHub

Amazon 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

Command Description
/q <message> Chat with the agent to ask questions or request revisions
/q review Requests an Amazon Q powered code review
/q help Displays usage information

Features

Agentic Chat
Enables interactive conversation with Amazon Q to ask questions about the pull request or request specific revisions. Use /q <message> in comment threads or the review body to engage with the agent directly.

Code Review
Analyzes pull requests for code quality, potential issues, and security concerns. Provides feedback and suggested fixes. Automatically triggered on new or reopened PRs (can be disabled for AWS registered installations), or manually with /q review slash command in a comment.

Customization

You can create project-specific rules for Amazon Q Developer to follow:

  1. Create a .amazonq/rules folder in your project root.
  2. Add Markdown files in this folder to define rules (e.g., cdk-rules.md).
  3. Write detailed prompts in these files, such as coding standards or best practices.
  4. Amazon Q Developer will automatically use these rules when generating code or providing assistance.

Example rule:

All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled.
All Amazon SNS topics must have encryption enabled and enforce SSL.
All Amazon SNS queues must enforce SSL.

Feedback

To 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

  1. Amazon Q Developer uses generative AI. You may need to verify generated code before using it in your environment. See the AWS Responsible AI Policy.

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
├── 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
# In any repo where you want these commands:
/plugin marketplace add atxtechbro/dotfiles
/plugin install dotfiles-commands@atxtechbro
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated

```
.claude-plugin/
├── plugin.json # Plugin metadata

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
**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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@atxtechbro
atxtechbro merged commit 2c33f52 into main Oct 9, 2025
@atxtechbro
atxtechbro deleted the fix/plugin-marketplace-source branch October 10, 2025 08:30
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