Add Teachers Assistant Educational Agent and How-To Build App Doc#1405
Add Teachers Assistant Educational Agent and How-To Build App Doc#1405OverlordBaconPants wants to merge 1 commit intobmad-code-org:mainfrom
Conversation
📝 WalkthroughWalkthroughThis PR introduces comprehensive documentation and configuration for the BMAD methodology, including guides for building web applications and custom agents. It also includes a complete example implementation of a Teachers Assistant educational agent with persistent memory structure, configuration files, and documentation templates for tracking student learning profiles and teaching technique effectiveness. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/how-to-create-custom-agent-bmad-method.md`:
- Around line 284-292: Update the example directory tree so it matches the
implementation: replace the direct "teachers-assistant-sidecar/" sibling with a
"_memory/" folder that contains "teachers-assistant-sidecar/"; ensure the
example shows agents/ → teachers-assistant/ → teachers-assistant.agent.yaml and
agents/ → teachers-assistant/ → _memory/ → teachers-assistant-sidecar/ with the
learning-profiles.md, technique-tracking.md and README.md entries, so the
symbols teachers-assistant.agent.yaml, _memory, and teachers-assistant-sidecar
are consistent with the PR.
🧹 Nitpick comments (1)
docs/how-to-create-custom-agent-bmad-method.md (1)
306-306: Inconsistent spelling of "standalone" vs "stand-alone".The document uses both variants:
stand-aloneon line 141 (and in the agent YAML) butstandalonehere and on line 330. Consider standardizing to one form throughout.
| ``` | ||
| agents/ | ||
| └── teachers-assistant/ | ||
| ├── teachers-assistant.agent.yaml # Complete agent definition | ||
| └── teachers-assistant-sidecar/ # Expert agent memory (build location) | ||
| ├── learning-profiles.md # Student progress and preferences | ||
| ├── technique-tracking.md # Teaching method effectiveness data | ||
| └── README.md # Sidecar documentation | ||
| ``` |
There was a problem hiding this comment.
Directory structure example doesn't match actual implementation.
The example shows teachers-assistant-sidecar/ directly under teachers-assistant/, but the actual implementation in this PR uses _memory/teachers-assistant-sidecar/ nested structure (as correctly shown in lines 319-323). This inconsistency could confuse users following the guide.
Suggested fix
**Teacher's Assistant Example:**
Generated complete Expert agent with this structure:agents/
└── teachers-assistant/
├── teachers-assistant.agent.yaml # Complete agent definition
- └── teachers-assistant-sidecar/ # Expert agent memory (build location)
- └── _memory/ # Expert agent memory (build location)
-
└── teachers-assistant-sidecar/ ├── learning-profiles.md # Student progress and preferences ├── technique-tracking.md # Teaching method effectiveness data └── README.md # Sidecar documentation
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| agents/ | |
| └── teachers-assistant/ | |
| ├── teachers-assistant.agent.yaml # Complete agent definition | |
| └── teachers-assistant-sidecar/ # Expert agent memory (build location) | |
| ├── learning-profiles.md # Student progress and preferences | |
| ├── technique-tracking.md # Teaching method effectiveness data | |
| └── README.md # Sidecar documentation | |
| ``` |
🤖 Prompt for AI Agents
In `@docs/how-to-create-custom-agent-bmad-method.md` around lines 284 - 292,
Update the example directory tree so it matches the implementation: replace the
direct "teachers-assistant-sidecar/" sibling with a "_memory/" folder that
contains "teachers-assistant-sidecar/"; ensure the example shows agents/ →
teachers-assistant/ → teachers-assistant.agent.yaml and agents/ →
teachers-assistant/ → _memory/ → teachers-assistant-sidecar/ with the
learning-profiles.md, technique-tracking.md and README.md entries, so the
symbols teachers-assistant.agent.yaml, _memory, and teachers-assistant-sidecar
are consistent with the PR.
| /bmad:core:agents:bmad-master | ||
| ``` | ||
|
|
||
| **Run workflow initialization:** |
There was a problem hiding this comment.
@OverlordBaconPants I know this is a pain, but can you update this all to use the bmad-help instead of workflow-init?
There was a problem hiding this comment.
Is this still needed or desired? I missed out ont the original PR (email flooded, totally my fault), so let me know if I should fix this or do something else entirely. Might be better to DM me in Discord.
|
closing here as this belongs in the bmb repo as discussed in discord with you @OverlordBaconPants |
2 participants
Summary
This PR introduces a complete educational agent implementation and comprehensive BMAD Method documentation, demonstrating the platform's capability to create specialized AI personas for educational use cases.
What's Added
🎓 Teachers Assistant Expert Agent (
my-educational-agents/)LG- Learning guidance through Socratic questioningQM- Quiz generation on challenging conceptsSA- Study aids creation (flashcards, practice problems, guides)ED- Alternative explanation methods when students struggleST- Story-based learning narrativesUP- Learning profile updatesLP- Progress tracking and insightsVC- Concept retention validationHC- Help system with examples📚 Comprehensive BMAD Method Documentation
how-to-create-custom-agent-bmad-method.md) - Complete walkthrough of the Agent Builder workflow, from brainstorming to production deploymenthow-to-build-web-app-bmad-method.md) - End-to-end methodology for building complete web applications using BMAD workflowsTechnical Implementation
Agent Architecture
Educational Philosophy
Module Structure
my-educational-agents/
├── module.yaml # Unitary module configuration
├── agents/
│ └── teachers-assistant/
│ ├── teachers-assistant.agent.yaml # Complete agent definition
│ └── _memory/ # Expert agent persistent memory
│ └── teachers-assistant-sidecar/
│ ├── learning-profiles.md # Student progress tracking
│ ├── technique-tracking.md # Teaching method effectiveness
│ └── README.md # Documentation
Use Cases Demonstrated
Installation
Ready for immediate installation via BMAD's module system. Users can integrate this educational agent into existing or new BMAD projects using standard installation workflows.
This contribution showcases the BMAD Method's flexibility in creating specialized AI personas while providing valuable educational tooling and comprehensive documentation for the community.