Skip to content

Commit d4a94df

Browse files
Brian MadisonBrian Madison
authored andcommitted
doc cleanup round 1
1 parent 949cf64 commit d4a94df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+202
-4456
lines changed

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
"tileset",
5858
"tmpl",
5959
"Trae",
60+
"Unsharded",
6061
"VNET",
6162
"webskip"
6263
],

docs/agent-customization-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Add your own workflows to the agent's menu:
8181
```yaml
8282
menu:
8383
- trigger: my-workflow
84-
workflow: '{project-root}/custom/my-workflow.yaml'
84+
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
8585
description: My custom workflow
8686
- trigger: deploy
8787
action: '#deploy-prompt'

docs/custom-content-installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,8 @@ To create an installable custom module:
2626
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
2727
- The folder name serves as the module code
2828

29-
2. **Required Files**
30-
- Include a `module.yaml` file in the root folder
31-
- This file drives the installation process when used by the BMAD installer
32-
- Reference existing modules or the BMad Builder for configuration examples
29+
2. **Required File**
30+
- Include a `module.yaml` file in the root folder (this drives questions for the final generated config.yaml at install target)
3331

3432
3. **Folder Organization**
3533
Follow these conventions for optimal compatibility:
@@ -56,8 +54,10 @@ For standalone content that isn't part of a cohesive module collection, follow t
5654

5755
1. **Module Configuration**
5856
- Create a folder with a `module.yaml` file (similar to custom modules)
59-
- Add the property `unitary: true` to the module.yaml
60-
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
57+
- Add the property `unitary: true` in the module.yaml
58+
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
59+
- Any content you add to this folder should still be nested under workflows and agents - but the key with stand alone content is they do not rely on each other.
60+
- Agents do not reference other workflows even if stored in a unitary:true module. But unitary Agents can have their own workflows in their sidecar, or reference workflows as requirements from other modules - with a process known as workflow vendoring. Keep in mind, this will require that the workflow referenced from the other module would need to be available for the end user to install, so its recommended to only vendor workflows from the core module, or official bmm modules (See [Workflow Vendoring, Customization, and Inheritance](workflow-vendoring-customization-inheritance.md)).
6161

6262
2. **Folder Structure**
6363
Organize content in specific named folders:

docs/custom-content.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Custom Content
22

3-
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agent provides workflows and expertise to plan and build any custom content you can imagine.
3+
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agents provides workflows and expertise to plan and build any custom content you can imagine.
44

55
This flexibility transforms the platform beyond its current capabilities, enabling:
66

@@ -21,7 +21,7 @@ This flexibility transforms the platform beyond its current capabilities, enabli
2121
- [Custom Global Modules](#custom-global-modules)
2222
- [Custom Agents](#custom-agents)
2323
- [BMad Tiny Agents](#bmad-tiny-agents)
24-
- [Simple vs Expert Agents](#simple-vs-expert-agents)
24+
- [Simple and Expert Agents](#simple-and-expert-agents)
2525
- [Custom Workflows](#custom-workflows)
2626

2727
## Custom Stand Alone Modules
@@ -57,7 +57,7 @@ Similar to Custom Stand Alone Modules, but designed to add functionality that ap
5757

5858
Examples include:
5959

60-
- The current TTS (Text-to-Speech) functionality for Claude, which will be rebuilt as a global module
60+
- The current TTS (Text-to-Speech) functionality for Claude, which will soon be converted to a global module
6161
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
6262
- Installation and update tools that work with any BMAD method configuration
6363

@@ -81,15 +81,14 @@ Personal agents designed for highly specific needs that may not be suitable for
8181

8282
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
8383

84-
### Simple vs Expert Agents
84+
### Simple and Expert Agents
8585

8686
The distinction between simple and expert agents lies in their structure:
8787

8888
**Simple Agent:**
8989

9090
- Single file containing all prompts and configuration
9191
- Self-contained and straightforward
92-
- has metadata type: simple
9392

9493
**Expert Agent:**
9594

0 commit comments

Comments
 (0)