docs: highlight module creation and sharing#62
Conversation
- README restructured with Create/Share section at top, marketplace and open standard messaging - All docs updated: em dashes removed, Claude-specific paths replaced with tool-agnostic examples - How-to guide restructured per Diataxis conventions (action verb steps, Quick Path tip) - Prose refined across all doc files for quality - Style guide updated to match new conventions
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (17)
WalkthroughThis PR standardizes punctuation and refines wording across the BMad Builder documentation. Primary changes include replacing em dashes with colons, semicolons, and parentheses for consistency; improving prose clarity in explanation guides; and restructuring how-to guides with refined framing and user guidance. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~10 minutes Possibly related PRs
Poem
✨ 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 |
🤖 Augment PR SummarySummary: This PR refreshes the documentation to foreground module creation and distribution, while standardizing punctuation and making examples less tool-specific. Changes:
Technical Notes: This is a docs-only change set; primary risk is link/format regressions (tables, internal routes, and marketplace/template URLs). 🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
| --- | ||
|
|
||
| Set up a GitHub repository so others can install your BMad module with a single command. | ||
| This guide walks through publishing a BMad module to GitHub with a `.claude-plugin/marketplace.json` manifest so anyone can install it in one command. |
There was a problem hiding this comment.
docs/how-to/distribute-your-module.md:6: The intro says “anyone can install it in one command”, but later the guide discusses private/org repos where only users with access can install. This could mislead readers about permission requirements.
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| | **Build Process** | BP | Build, edit, convert, or fix agents | Build, edit, convert, or fix workflows and utilities | | ||
| | **Quality Optimize** | QO | Validate and optimize existing agents | Validate and optimize existing workflows and utilities | | ||
| | **Convert** | CW | — | Convert any skill to BMad-compliant, outcome-driven equivalent with comparison report | | ||
| | **Convert** | CW | - | Convert any skill to BMad-compliant, outcome-driven equivalent with comparison report | |
There was a problem hiding this comment.
docs/reference/builder-commands.md:14: Using a bare - in table cells to mean “not applicable” is ambiguous (it can read like a minus sign) and may confuse readers scanning capability matrices. Consider using a clearer N/A marker consistently; other locations where this applies: docs/reference/builder-commands.md:88, docs/reference/builder-commands.md:89, docs/reference/builder-commands.md:90, docs/reference/builder-commands.md:91, docs/reference/builder-commands.md:92.
Severity: low
Other Locations
docs/reference/builder-commands.md:88docs/reference/builder-commands.md:89docs/reference/builder-commands.md:90docs/reference/builder-commands.md:91docs/reference/builder-commands.md:92
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
1 participant
Summary
Test plan
Summary by CodeRabbit
Release Notes