rebuild sample with merged fixes

This commit is contained in:
Brian Madison
2025-05-20 18:58:02 -05:00
parent e513ddfbe1
commit 4d6e824f89
3 changed files with 46 additions and 44 deletions

View File

@@ -64,7 +64,7 @@ When these commands are used, perform the listed action
- `/{agent}`: If in BMad Orchestrator mode, immediate switch to selected agent (if there is a match) - if already in another agent persona - confirm the switch. - `/{agent}`: If in BMad Orchestrator mode, immediate switch to selected agent (if there is a match) - if already in another agent persona - confirm the switch.
- `/exit`: Immediately abandon the current agent or party-mode and drop to base BMad Orchestrator - `/exit`: Immediately abandon the current agent or party-mode and drop to base BMad Orchestrator
- `/doc-out`: If a doc is being talked about or refined, output the full document untruncated. - `/doc-out`: If a doc is being talked about or refined, output the full document untruncated.
- `/agent-{agent}`: Immediate swap to a new agent persona - which will great on change. - `/agent-{agent}`: Immediate swap to a new agent persona - which will greet on change.
- `/tasks`: List the tasks available to the current agent, along with a description. - `/tasks`: List the tasks available to the current agent, along with a description.
- `/bmad {query}`: Even if in an agent - you can talk to base BMad with your query. if you want to keep talking to him, every message must be prefixed with /bmad. - `/bmad {query}`: Even if in an agent - you can talk to base BMad with your query. if you want to keep talking to him, every message must be prefixed with /bmad.
- `/{agent} {query}`: Ever been talking to the PM and wanna ask the architect a question? Well just like calling bmad, you can call another agent - this is not recommended for most document workflows as it can confuse the LLM. - `/{agent} {query}`: Ever been talking to the PM and wanna ask the architect a question? Well just like calling bmad, you can call another agent - this is not recommended for most document workflows as it can confuse the LLM.

View File

@@ -3,29 +3,31 @@
## INDEX OF TOPICS ## INDEX OF TOPICS
- [BMAD METHOD - CORE PHILOSOPHY](#bmad-method---core-philosophy) - [BMAD Knowledge Base](#bmad-knowledge-base)
- [BMAD METHOD - AGILE METHODOLOGIES OVERVIEW](#bmad-method---agile-methodologies-overview) - [INDEX OF TOPICS](#index-of-topics)
- [CORE PRINCIPLES OF AGILE](#core-principles-of-agile) - [BMAD METHOD - CORE PHILOSOPHY](#bmad-method---core-philosophy)
- [KEY PRACTICES IN AGILE](#key-practices-in-agile) - [BMAD METHOD - AGILE METHODOLOGIES OVERVIEW](#bmad-method---agile-methodologies-overview)
- [BENEFITS OF AGILE](#benefits-of-agile) - [CORE PRINCIPLES OF AGILE](#core-principles-of-agile)
- [BMAD METHOD - ANALOGIES WITH AGILE PRINCIPLES](#bmad-method---analogies-with-agile-principles) - [KEY PRACTICES IN AGILE](#key-practices-in-agile)
- [BMAD METHOD - TOOLING AND RESOURCE LOCATIONS](#bmad-method---tooling-and-resource-locations) - [BENEFITS OF AGILE](#benefits-of-agile)
- [BMAD METHOD - COMMUNITY AND CONTRIBUTIONS](#bmad-method---community-and-contributions) - [BMAD METHOD - ANALOGIES WITH AGILE PRINCIPLES](#bmad-method---analogies-with-agile-principles)
- [Licensing](#licensing) - [BMAD METHOD - TOOLING AND RESOURCE LOCATIONS](#bmad-method---tooling-and-resource-locations)
- [BMAD METHOD - ETHOS & BEST PRACTICES](#bmad-method---ethos--best-practices) - [BMAD METHOD - COMMUNITY AND CONTRIBUTIONS](#bmad-method---community-and-contributions)
- [AGENT ROLES](#agent-roles) - [Licensing](#licensing)
- [NAVIGATING THE BMAD WORKFLOW - INITIAL GUIDANCE](#navigating-the-bmad-workflow---initial-guidance) - [BMAD METHOD - ETHOS \& BEST PRACTICES](#bmad-method---ethos--best-practices)
- [STARTING YOUR PROJECT - ANALYST OR PM?](#starting-your-project---analyst-or-pm) - [AGENT ROLES AND RESPONSIBILITIES](#agent-roles-and-responsibilities)
- [UNDERSTANDING EPICS - SINGLE OR MULTIPLE?](#understanding-epics---single-or-multiple) - [NAVIGATING THE BMAD WORKFLOW - INITIAL GUIDANCE](#navigating-the-bmad-workflow---initial-guidance)
- [SUGGESTED ORDER OF AGENT ENGAGEMENT (TYPICAL FLOW)](#suggested-order-of-agent-engagement-typical-flow) - [STARTING YOUR PROJECT - ANALYST OR PM?](#starting-your-project---analyst-or-pm)
- [HANDLING MAJOR CHANGES](#handling-major-changes) - [UNDERSTANDING EPICS - SINGLE OR MULTIPLE?](#understanding-epics---single-or-multiple)
- [IDE VS UI USAGE - GENERAL RECOMMENDATIONS](#ide-vs-ui-usage---general-recommendations) - [SUGGESTED ORDER OF AGENT ENGAGEMENT (TYPICAL FLOW)](#suggested-order-of-agent-engagement-typical-flow)
- [CONCEPTUAL AND PLANNING PHASES](#conceptual-and-planning-phases) - [HANDLING MAJOR CHANGES](#handling-major-changes)
- [TECHNICAL DESIGN, DOCUMENTATION MANAGEMENT & IMPLEMENTATION PHASES](#technical-design-documentation-management--implementation-phases) - [IDE VS UI USAGE - GENERAL RECOMMENDATIONS](#ide-vs-ui-usage---general-recommendations)
- [BMAD METHOD FILES](#bmad-method-files) - [CONCEPTUAL AND PLANNING PHASES](#conceptual-and-planning-phases)
- [LEVERAGING IDE TASKS FOR EFFICIENCY](#leveraging-ide-tasks-for-efficiency) - [TECHNICAL DESIGN, DOCUMENTATION MANAGEMENT \& IMPLEMENTATION PHASES](#technical-design-documentation-management--implementation-phases)
- [PURPOSE OF IDE TASKS](#purpose-of-ide-tasks) - [BMAD METHOD FILES](#bmad-method-files)
- [EXAMPLES OF TASK FUNCTIONALITY](#examples-of-task-functionality) - [LEVERAGING IDE TASKS FOR EFFICIENCY](#leveraging-ide-tasks-for-efficiency)
- [PURPOSE OF IDE TASKS](#purpose-of-ide-tasks)
- [EXAMPLES OF TASK FUNCTIONALITY](#examples-of-task-functionality)
## BMAD METHOD - CORE PHILOSOPHY ## BMAD METHOD - CORE PHILOSOPHY
@@ -142,13 +144,13 @@ The BMAD Method thrives on community involvement and collaborative improvement.
- **Reporting Bugs:** If you find a bug, check existing issues first. If unreported, provide detailed steps to reproduce, along with any relevant logs or screenshots. - **Reporting Bugs:** If you find a bug, check existing issues first. If unreported, provide detailed steps to reproduce, along with any relevant logs or screenshots.
- **Suggesting Features:** Check existing issues and discussions. Explain your feature idea in detail and its potential value. - **Suggesting Features:** Check existing issues and discussions. Explain your feature idea in detail and its potential value.
- **Contribution Process (Pull Requests):** - **Contribution Process (Pull Requests):**
1. Fork the repository. 1. Fork the repository.
2. Create a new branch for your feature or bugfix (e.g., `feature/your-feature-name`). 2. Create a new branch for your feature or bugfix (e.g., `feature/your-feature-name`).
3. Make your changes, adhering to existing code style and conventions. Write clear comments for complex logic. 3. Make your changes, adhering to existing code style and conventions. Write clear comments for complex logic.
4. Run any tests or linting to ensure quality. 4. Run any tests or linting to ensure quality.
5. Commit your changes with clear, descriptive messages (refer to the project's commit message convention, often found in `docs/commit.md`). 5. Commit your changes with clear, descriptive messages (refer to the project's commit message convention, often found in `docs/commit.md`).
6. Push your branch to your fork. 6. Push your branch to your fork.
7. Open a Pull Request against the main branch of the original repository. 7. Open a Pull Request against the main branch of the original repository.
- **Code of Conduct:** All participants are expected to abide by the project's Code of Conduct. - **Code of Conduct:** All participants are expected to abide by the project's Code of Conduct.
- **Licensing of Contributions:** By contributing, you agree that your contributions will be licensed under the same license as the project (MIT License). - **Licensing of Contributions:** By contributing, you agree that your contributions will be licensed under the same license as the project (MIT License).
@@ -178,7 +180,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
- **EMBRACE_THE_CHAOS:** Pioneering new methods is messy. Adapt and overcome. - **EMBRACE_THE_CHAOS:** Pioneering new methods is messy. Adapt and overcome.
- **ADAPT & EXPERIMENT:** The BMAD Method provides a structure, but feel free to adapt its principles, agent order, or templates to fit your specific project needs and working style. Experiment to find what works best for you. **Define agile the BMad way - or your way!** The agent configurations allow for customization of roles and responsibilities. - **ADAPT & EXPERIMENT:** The BMAD Method provides a structure, but feel free to adapt its principles, agent order, or templates to fit your specific project needs and working style. Experiment to find what works best for you. **Define agile the BMad way - or your way!** The agent configurations allow for customization of roles and responsibilities.
## AGENT ROLES ## AGENT ROLES AND RESPONSIBILITIES
Understanding the distinct roles and responsibilities of each agent is key to effectively navigating the BMAD workflow. While the "Vibe CEO" provides overall direction, each agent specializes in different aspects of the project lifecycle. V3 introduces Orchestrator agents that can embody these roles, with configurations specified in `web-bmad-orchestrator-agent-cfg.md` for web and `ide-bmad-orchestrator-cfg.md` for IDE environments. Understanding the distinct roles and responsibilities of each agent is key to effectively navigating the BMAD workflow. While the "Vibe CEO" provides overall direction, each agent specializes in different aspects of the project lifecycle. V3 introduces Orchestrator agents that can embody these roles, with configurations specified in `web-bmad-orchestrator-agent-cfg.md` for web and `ide-bmad-orchestrator-cfg.md` for IDE environments.
@@ -261,15 +263,15 @@ Understanding the distinct roles and responsibilities of each agent is key to ef
**NOTE:** This is a general guideline. The BMAD method is iterative; phases/agents might be revisited. **NOTE:** This is a general guideline. The BMAD method is iterative; phases/agents might be revisited.
1. **Analyst** - brainstorm and create a project brief. 1. **Analyst** - brainstorm and create a project brief.
2. **PM (Product Manager)** - use the brief to produce a PRD with high level epics and stories. 2. **PM (Product Manager)** - use the brief to produce a PRD with high level epics and stories.
3. **Design Architect UX UI Spec for PRD (If project has a UI)** - create the front end UX/UI Specification. 3. **Design Architect UX UI Spec for PRD (If project has a UI)** - create the front end UX/UI Specification.
4. **Architect** - create the architecture and ensure we can meet the prd requirements technically - with enough specification that the dev agents will work consistently. 4. **Architect** - create the architecture and ensure we can meet the prd requirements technically - with enough specification that the dev agents will work consistently.
5. **Design Architect (If project has a UI)** - create the front end architecture and ensure we can meet the prd requirements technically - with enough specification that the dev agents will work consistently. 5. **Design Architect (If project has a UI)** - create the front end architecture and ensure we can meet the prd requirements technically - with enough specification that the dev agents will work consistently.
6. **Design Architect (If project has a UI)** - Optionally create a prompt to generate a UI from AI services such as Lovable or V0 from Vercel. 6. **Design Architect (If project has a UI)** - Optionally create a prompt to generate a UI from AI services such as Lovable or V0 from Vercel.
7. **PO**: Validate documents are aligned, sequencing makes sense, runs a final master checklist. The PO can also help midstream development replan or course correct if major changes occur. 7. **PO**: Validate documents are aligned, sequencing makes sense, runs a final master checklist. The PO can also help midstream development replan or course correct if major changes occur.
8. **PO or SM**: Generate Stories 1 at a time (or multiple but not recommended) - this is generally done in the IDE after each story is completed by the Developer Agents. 8. **PO or SM**: Generate Stories 1 at a time (or multiple but not recommended) - this is generally done in the IDE after each story is completed by the Developer Agents.
9. **Developer Agents**: Implement Stories 1 at a time. You can craft different specialized Developer Agents, or use a generic developer agent. It is recommended to create specialized developer agents and configure them in the `ide-bmad-orchestrator-cfg`. 9. **Developer Agents**: Implement Stories 1 at a time. You can craft different specialized Developer Agents, or use a generic developer agent. It is recommended to create specialized developer agents and configure them in the `ide-bmad-orchestrator-cfg`.
## HANDLING MAJOR CHANGES ## HANDLING MAJOR CHANGES

View File

@@ -681,8 +681,8 @@ To identify the next logical story based on project progress and epic definition
- Data Models Document (as referenced in Index Doc) - Data Models Document (as referenced in Index Doc)
- API Reference Document (as referenced in Index Doc) - API Reference Document (as referenced in Index Doc)
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc) - UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
- The `docs/templates/story-template.md` (hereafter "Story Template") - The `bmad-agent/templates/story-tmpl.md` (hereafter "Story Template")
- The `docs/checklists/story-draft-checklist.txt` (hereafter "Story Draft Checklist") - The `bmad-agent/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories. - User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
## Task Execution Instructions ## Task Execution Instructions
@@ -1085,7 +1085,7 @@ To collaboratively work with the user to define and document the User Interface
==================== START: doc-sharding-task ==================== ==================== START: doc-sharding-task ====================
# Paste the following prompt into your agent chat to have it run Doc Sharding # Doc Sharding Task
You are now operating as a Technical Documentation Librarian tasked with granulating large project documents into smaller, organized files. Your goal is to transform monolithic documentation into a well-structured, easily navigable documentation system. You are now operating as a Technical Documentation Librarian tasked with granulating large project documents into smaller, organized files. Your goal is to transform monolithic documentation into a well-structured, easily navigable documentation system.