Skip to content

Commit fd02020

Browse files
Brian MadisonBrian Madison
authored andcommitted
refactor: reorganize reference agents by hasSidecar configuration
Rename reference folders to reflect the simplified agent model: - simple-examples/ → without-sidecar/ - expert-examples/ → with-sidecar/ - module-examples/ → keep (different category: agents in modules) Also fix journal-keeper.agent.yaml inconsistency: - Had hasSidecar: false but included critical_actions with sidecar paths - Now correctly has hasSidecar: true with sidecar-folder metadata This aligns reference examples with the single Agent type model that uses hasSidecar boolean for configuration.
1 parent ff12d73 commit fd02020

16 files changed

Lines changed: 23 additions & 21 deletions

docs/tutorials/create-custom-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ Yes. Package your agent as a standalone module and share it with your team or th
149149

150150
**Where can I see example agents?**
151151
Study the reference agents in `src/modules/bmb/reference/agents/`:
152-
- [commit-poet](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) (Simple)
153-
- [journal-keeper](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) (Expert)
152+
- [commit-poet](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/without-sidecar/commit-poet.agent.yaml) (Simple)
153+
- [journal-keeper](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/with-sidecar/journal-keeper) (Expert)
154154

155155
## Getting Help
156156

src/workflows/agent/data/agent-architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ Two forms:
301301

302302
| Type | Path | Features |
303303
|------|------|----------|
304-
| WITHOUT sidecar | `data/reference/simple-examples/commit-poet.agent.yaml` | Poetic persona, 4 prompts, 7 menu items, 127 lines |
305-
| WITH sidecar | `data/reference/expert-examples/journal-keeper/` | First-person persona with memory, critical_actions, sidecar updates |
304+
| WITHOUT sidecar | `data/reference/without-sidecar/commit-poet.agent.yaml` | Poetic persona, 4 prompts, 7 menu items, 127 lines |
305+
| WITH sidecar | `data/reference/with-sidecar/journal-keeper/` | First-person persona with memory, critical_actions, sidecar updates |
306306

307307
---
308308

src/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md renamed to src/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/breakthroughs.md

File renamed without changes.

src/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md renamed to src/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md

File renamed without changes.

src/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md renamed to src/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/instructions.md

File renamed without changes.

src/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md renamed to src/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/memories.md

File renamed without changes.

src/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md renamed to src/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/mood-patterns.md

File renamed without changes.

src/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml renamed to src/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper.agent.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ agent:
55
title: "Personal Journal Companion"
66
icon: "📔"
77
module: stand-alone
8-
hasSidecar: false
8+
hasSidecar: true
9+
sidecar-folder: journal-keeper-sidecar
10+
sidecar-path: '{project-root}/_bmad/_memory/journal-keeper-sidecar/'
911

1012
persona:
1113
role: "Thoughtful Journal Companion with Pattern Recognition"

src/workflows/agent/data/reference/simple-examples/commit-poet.agent.yaml renamed to src/workflows/agent/data/reference/without-sidecar/commit-poet.agent.yaml

File renamed without changes.

src/workflows/agent/data/understanding-agent-types.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Understanding Agent Types
22

33
> **For the LLM running this workflow:** Load and review the example files referenced below when helping users choose an agent configuration.
4-
> - Without sidecar: `{workflow_path}/data/reference/simple-examples/commit-poet.agent.yaml`
5-
> - With sidecar: `{workflow_path}/data/reference/expert-examples/journal-keeper/`
4+
> - Without sidecar: `{workflow_path}/data/reference/without-sidecar/commit-poet.agent.yaml`
5+
> - With sidecar: `{workflow_path}/data/reference/with-sidecar/journal-keeper/`
66
77
---
88

@@ -74,7 +74,7 @@ agent-name.agent.yaml (~250 lines max)
7474
- Can have critical_actions for activation behaviors (quotes, data fetches, etc.)
7575
- Must NOT reference sidecar files (no sidecar exists)
7676

77-
**Reference:** `./data/reference/simple-examples/commit-poet.agent.yaml`
77+
**Reference:** `./data/reference/without-sidecar/commit-poet.agent.yaml`
7878

7979
---
8080

@@ -110,7 +110,7 @@ agent-name.agent.yaml
110110
- Language tutor (tracks vocabulary, learning history)
111111
- Domain advisor with custom knowledge base
112112

113-
**Reference:** `./data/reference/expert-examples/journal-keeper/`
113+
**Reference:** `./data/reference/with-sidecar/journal-keeper/`
114114

115115
**Required critical_actions:**
116116
```yaml

0 commit comments

Comments
 (0)