docs: update path references from BETA-V3 to bmad-agent in instruction.md

## CHANGES

- Update all BETA-V3 directory references to bmad-agent
- Clarify paths are relative to bmad-agent directory
- Fix markdown formatting for numbered lists
- Update IDE orchestrator configuration path examples
- Correct agent-root path in Data Resolution section
- Remove references to deprecated BETA-V3 structure
This commit is contained in:
Kayvan Sylvan 2025-05-28 13:57:04 -07:00
parent 1593100e0c
commit 7d468fa3b0
1 changed files with 24 additions and 24 deletions

View File

@ -31,7 +31,7 @@ The build process is configured via `build-web-agent.cfg.js`. Key parameters inc
- `agent_cfg`: Specifies the path to the md cfg file that defines the agents the Orchestrator can embody.
- Example: `./bmad-agent/web-bmad-orchestrator-agent.cfg.md`
Paths in the configuration file (`build-web-agent.cfg.js`) are relative to the `BETA-V3` directory (where `build-web-agent.cfg.js` and the build script `build-bmad-orchestrator.js` are located).
Paths in the configuration file (`build-web-agent.cfg.js`) are relative to the `bmad-agent` directory (where `build-web-agent.cfg.js` and the build script `build-bmad-orchestrator.js` are located).
### Asset Directory Structure
@ -73,9 +73,9 @@ These bundled files and the agent prompt are then ready to be used by the Agent
The text in agent-prompt.txt gets entered into the window of the main custom web agent instruction set. The other files in the build folder all need to be attached as files for the Gem or GPT.
### Orchestrator Agent Configuration (e.g., `BETA-V3/bmad-agent/web-bmad-orchestrator-agent.cfg.md`)
### Orchestrator Agent Configuration (e.g., `bmad-agent/web-bmad-orchestrator-agent.cfg.md`)
While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core behavior, agent definitions, and personality are defined in a Markdown configuration file. An example is `bmad-agent/web-bmad-orchestrator-agent.cfg.md` (path relative to `BETA-V3/`, specified in `build-web-agent.cfg.js` via `agent_cfg`). This file is key to the Orchestrator's adaptability.
While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core behavior, agent definitions, and personality are defined in a Markdown configuration file. An example is `bmad-agent/web-bmad-orchestrator-agent.cfg.md` (path relative to `bmad-agent/`, specified in `build-web-agent.cfg.js` via `agent_cfg`). This file is key to the Orchestrator's adaptability.
**Key Features and Configurability:**
@ -138,7 +138,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
#### How the IDE Orchestrator Works
1. **Configuration (`ide-bmad-orchestrator.cfg.md`):**
The orchestrator's behavior is primarily driven by a Markdown configuration file (e.g., `BETA-V3/bmad-agent/ide-bmad-orchestrator.cfg.md`, the path to which is specified within the `ide-bmad-orchestrator.md` itself). This config file has two main parts:
The orchestrator's behavior is primarily driven by a Markdown configuration file (e.g., `bmad-agent/ide-bmad-orchestrator.cfg.md`, the path to which is specified within the `ide-bmad-orchestrator.md` itself). This config file has two main parts:
- **Data Resolution:**
Located at the top of the config file, this section defines key-value pairs for base paths. These paths tell the orchestrator where to find different types of asset files (personas, tasks, checklists, templates, data).
@ -148,7 +148,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
## Data Resolution
agent-root: (project-root)/BETA-V3/bmad-agent
agent-root: (project-root)/bmad-agent
checklists: (agent-root)/checklists
data: (agent-root)/data
personas: (agent-root)/personas
@ -202,7 +202,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
#### Usage Instructions for IDE Orchestrator
1. **Set up your configuration (`ide-bmad-orchestrator.cfg.md`):**
- Ensure you have an `ide-bmad-orchestrator.cfg.md` file. You can use the one located in `BETA-V3/bmad-agent/` as a template or starting point.
- Ensure you have an `ide-bmad-orchestrator.cfg.md` file. You can use the one located in `bmad-agent/` as a template or starting point.
- Verify that the `Data Resolution` paths at the top correctly point to your asset folders (personas, tasks, templates, checklists, data) relative to your project structure.
- Define your desired agents with their `Title`, `Name`, `Customize` instructions, `Persona` file, and `Tasks`. Ensure the referenced persona and task files exist in the locations specified by your `Data Resolution` paths.
2. **Set up your persona and task files:**