Skip to content

Commit 678b69b

Browse files
authored
docs: highlight module creation and sharing across README and docs (#62)
- 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
1 parent 9854311 commit 678b69b

17 files changed

Lines changed: 253 additions & 258 deletions

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,37 @@
66

77
**Build More, Architect Dreams... With the BMad Builder!**
88

9-
BMad Builder is so much more than a skill builder. BMad Method modules support:
9+
## Create, Share, and Discover Modules
1010

11-
- **Agents** that transform your AI tool into exactly who you need to talk to — with memory that persists across sessions
12-
- **Workflows** that go far beyond simple tasks into truly guided, facilitated processes that can produce near-infinite steps and turns as needed
13-
- **Modules** that are entire ecosystems, not just skill packs — like the BMad Method module for agile AI-driven development. You can create simpler or vastly more complex modules for any entertainment or work purpose.
11+
BMad Builder gives you the complete pipeline to create your own AI modules and share them with the world. Build agents with persistent memory, guided workflows, or full module ecosystems, then distribute them through the [BMad Marketplace](https://github.com/bmad-code-org/bmad-plugins-marketplace) or any compliant public marketplace.
12+
13+
The [Agent Skills open standard](https://agentskills.io/home) means your creations work across 40+ AI tools, not just one platform - but with the BMad Ecosystem they will also gain full integration.
14+
15+
| Guide | What It Covers |
16+
| ----- | -------------- |
17+
| **[Quick Start](https://bmad-builder-docs.bmad-method.org)** | Set up BMad Builder and build your first skill |
18+
| **[Build Your First Module](https://bmad-builder-docs.bmad-method.org/tutorials/build-your-first-module/)** | Plan, build, scaffold, and validate a complete module |
19+
| **[Distribute Your Module](https://bmad-builder-docs.bmad-method.org/how-to/distribute-your-module/)** | Package and share your module for anyone to install |
1420

1521
## The Dream
1622

17-
Imagine AI that truly knows you — a fitness coach that remembers every PR, a writing partner that knows your characters better than you do, a research assistant that learns your preferences.
23+
Imagine AI that truly knows you. A fitness coach that remembers every PR. A writing partner that knows your characters better than you do. A research assistant that learns your preferences.
1824

1925
BMad Builder lets you create:
2026

21-
- **Personal AI Companions** Agents with memory that evolve with you over time
22-
- **Domain Experts** Specialists for any field: legal, medical, creative, technical
23-
- **Workflow Automations** Structured processes that guide you through complex tasks
24-
- **Custom Modules** Bundle agents and workflows into shareable packages that can empower any type of business or domain
27+
- **Personal AI Companions**: Agents with memory that evolve with you over time
28+
- **Domain Experts**: Specialists for any field: legal, medical, creative, technical
29+
- **Workflow Automations**: Structured processes that guide you through complex tasks
30+
- **Custom Modules**: Bundle agents and workflows into shareable packages that can empower any type of business or domain
2531

2632
## What Makes It Different
2733

2834
| Feature | Why It Matters |
2935
| --------------------- | ----------------------------------------------------------- |
30-
| **Persistent Memory** | Agents remember across sessions — they learn and grow |
36+
| **Persistent Memory** | Agents remember across sessions and keep improving |
3137
| **Composable** | Your creations work alongside the entire BMad ecosystem |
32-
| **Skill-Compliant** | Built on open standards that work with any AI tool |
33-
| **Shareable** | Package your modules for the BMad Marketplace (coming soon) |
38+
| **Skill-Compliant** | Built on the open Agent Skills standard, works with 40+ AI tools |
39+
| **Shareable** | Distribute through the BMad Marketplace or any compliant marketplace |
3440

3541
## What You Can Build
3642

@@ -43,20 +49,18 @@ BMad Builder lets you create:
4349

4450
## Learn More
4551

46-
**[Documentation and Quick Start](https://bmad-builder-docs.bmad-method.org)**
47-
48-
Complete guides for building agents, workflows, and modules.
52+
**[Full Documentation](https://bmad-builder-docs.bmad-method.org)**: Concepts, design patterns, and reference for the complete builder toolkit.
4953

5054
## Community
5155

52-
- **[Discord](https://discord.gg/gk8jAdXWmj)** Get help and share what you've built
53-
- **[BMad Method](https://docs.bmad-method.org)** Core framework documentation
56+
- **[Discord](https://discord.gg/gk8jAdXWmj)**: Get help and share what you've built
57+
- **[BMad Method](https://docs.bmad-method.org)**: Core framework documentation
5458

5559
## License
5660

57-
MIT — see [LICENSE](LICENSE) for details.
61+
MIT. See [LICENSE](LICENSE) for details.
5862

59-
**BMad Builder** Part of the [BMad Method](https://github.com/bmad-code-org/BMAD-METHOD) ecosystem.
63+
**BMad Builder**: Part of the [BMad Method](https://github.com/bmad-code-org/BMAD-METHOD) ecosystem.
6064

6165
[![Contributors](https://contrib.rocks/image?repo=bmad-code-org/bmad-builder)](https://github.com/bmad-code-org/bmad-builder/graphs/contributors)
6266

docs/_STYLE_GUIDE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Caveats, potential issues
3535
:::
3636

3737
:::danger[Title]
38-
Critical warnings only data loss, security issues
38+
Critical warnings only: data loss, security issues
3939
:::
4040
```
4141

@@ -56,7 +56,7 @@ Critical warnings only — data loss, security issues
5656
| Phase | Name | What Happens |
5757
| ----- | -------- | -------------------------------------------- |
5858
| 1 | Analysis | Brainstorm, research _(optional)_ |
59-
| 2 | Planning | Requirements PRD or tech-spec _(required)_ |
59+
| 2 | Planning | Requirements: PRD or tech-spec _(required)_ |
6060
```
6161

6262
**Commands:**
@@ -266,7 +266,7 @@ your-project/
266266
1. Title + Hook
267267
2. Table of Contents (jump links if 4+ items)
268268
3. Items (## for each config/task)
269-
- **Bold summary** one sentence
269+
- **Bold summary**: one sentence
270270
- **Use it when:** bullet list
271271
- **How it works:** numbered steps (3-5 max)
272272
- **Output:** expected result (optional)
@@ -297,9 +297,9 @@ your-project/
297297

298298
Starlight generates right-side "On this page" navigation from headers:
299299

300-
- Categories as `##` headers appear in right nav
301-
- Terms in tables — compact rows, not individual headers
302-
- No inline TOC right sidebar handles navigation
300+
- Categories as `##` headers (appear in right nav)
301+
- Terms in tables, not individual headers
302+
- No inline TOC; right sidebar handles navigation
303303

304304
### Table Format
305305

docs/explanation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Create world-class AI agents and workflows with the BMad Builder.
1919

2020
| Topic | Description |
2121
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
22-
| **[Progressive Disclosure](/explanation/progressive-disclosure.md)** | Four layers of context loadingfrom frontmatter through step files |
22+
| **[Progressive Disclosure](/explanation/progressive-disclosure.md)** | Four layers of context loading, from frontmatter through step files |
2323
| **[Subagent Patterns](/explanation/subagent-patterns.md)** | Six orchestration patterns for parallel and hierarchical work |
2424
| **[Skill Authoring Best Practices](/explanation/skill-authoring-best-practices.md)** | Core principles, common patterns, quality dimensions, and anti-patterns |
2525
| **[Scripts in Skills](/explanation/scripts-in-skills.md)** | Why deterministic scripts make skills faster, cheaper, and more reliable |

0 commit comments

Comments
 (0)