Skip to content

docs: add getting started section and marketplace link to distribution guide#61

Merged
bmadcode merged 1 commit intomainfrom
marketplace-link
Apr 4, 2026
Merged

docs: add getting started section and marketplace link to distribution guide#61
bmadcode merged 1 commit intomainfrom
marketplace-link

Conversation

@bmadcode
Copy link
Copy Markdown
Contributor

@bmadcode bmadcode commented Apr 4, 2026

Summary

  • Add Getting Started section with BMad Module Template link and step-by-step workflow
  • Add marketplace listing section pointing to CONTRIBUTING.md

Summary by CodeRabbit

  • Documentation
    • Enhanced module distribution guide with new Getting Started section covering end-to-end onboarding flow using BMad Module Template and Builder.
    • Added guidance for existing repositories to generate required configuration files and registration files using Module Builder scaffolding.
    • Introduced marketplace listing section with clear instructions on the optional submission process to the BMad Plugins Marketplace.

@bmadcode bmadcode merged commit 9854311 into main Apr 4, 2026
3 of 5 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 4, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 899bcfd4-23cb-458d-9465-818ba84a27e2

📥 Commits

Reviewing files that changed from the base of the PR and between 4ffd94c and 2f404fc.

📒 Files selected for processing (1)
  • docs/how-to/distribute-your-module.md

Walkthrough

The documentation adds a new "Getting Started" section with an end-to-end onboarding flow for the BMad Module Template and Builder, plus a "List Your Module in the Marketplace" section describing optional marketplace submission processes.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/how-to/distribute-your-module.md
Added "Getting Started" section with recommended onboarding flow using BMad Module Template and Builder, including steps for creating skills, organizing them under skills/, populating .claude-plugin/marketplace.json, and adding documentation. Also added "List Your Module in the Marketplace" section explaining optional marketplace submission with reference to submission guidelines.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hops through docs with glee,
New pathways clear for all to see,
Getting Started guides the way,
Marketplace doors now open today! 🚀

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch marketplace-link

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.

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Apr 6, 2026

🤖 Augment PR Summary

Summary: Updates the module distribution guide with a quicker onboarding path and a pointer to the community marketplace.

Changes:

  • Adds a new Getting Started section linking to the BMad Module Template and outlining a recommended workflow
  • Adds a new section describing how to optionally list a published module in the BMad marketplace (with a link to submission instructions)

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

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

Review completed. 1 suggestion posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.


## Getting Started

The fastest way to start is with the [BMad Module Template](https://github.com/bmad-code-org/bmad-module-template):
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The linked bmad-module-template appears to be structured around src/ (e.g., module.yaml/agents/workflows) rather than the .claude-plugin/marketplace.json + skills/ layout described in this Getting Started checklist. Consider clarifying which module distribution format this section is targeting so readers don’t end up following the wrong repo structure.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

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