diff --git a/.gitignore b/.gitignore index 50e51c8f..3fdf28c4 100644 --- a/.gitignore +++ b/.gitignore @@ -63,6 +63,4 @@ src/modules/bmb/sub-modules/ src/modules/cis/sub-modules/ src/modules/bmgd/sub-modules/ -# Test Install Output -z-samples -z*/.claude/settings.local.json +z*/ \ No newline at end of file diff --git a/docs/USING_WEB_BUNDLES.md b/docs/USING_WEB_BUNDLES.md deleted file mode 100644 index 19f3b5d6..00000000 --- a/docs/USING_WEB_BUNDLES.md +++ /dev/null @@ -1,96 +0,0 @@ -# Using BMAD Web Bundles (For Users) - -**Audience:** Users wanting to use BMAD agents in Claude Projects, ChatGPT, or Gemini - ---- - -## Quick Start - -**1. Pick your channel:** - -- **Stable:** `https://github.com/bmad-code-org/BMAD-METHOD/releases/latest` -- **Latest:** `https://bmad-code-org.github.io/bmad-bundles/` - -**2. Copy raw XML URL:** - -``` -https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/pm.xml -``` - -**3. Add to AI platform:** - -- **Claude Projects:** Project Knowledge → Add URL -- **ChatGPT:** Custom Instructions → Paste content -- **Gemini Gems:** Knowledge → Add URL - ---- - -## Available Modules - -**Bulk Downloads:** - -- [📦 BMM Agents (8)](https://bmad-code-org.github.io/bmad-bundles/downloads/bmm-agents.zip) -- [📦 BMB Agents (1)](https://bmad-code-org.github.io/bmad-bundles/downloads/bmb-agents.zip) -- [📦 CIS Agents (5)](https://bmad-code-org.github.io/bmad-bundles/downloads/cis-agents.zip) -- [📦 BMGD Agents (4)](https://bmad-code-org.github.io/bmad-bundles/downloads/bmgd-agents.zip) - -**Individual Agents:** - -### BMM (BMad Method) - -- [PM](https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/pm.xml) | [Architect](https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/architect.xml) | [TEA](https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/tea.xml) | [Developer](https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/dev.xml) -- [Browse All](https://bmad-code-org.github.io/bmad-bundles/bmm/agents/) - -### BMB / CIS / BMGD - -- [Browse BMB](https://bmad-code-org.github.io/bmad-bundles/bmb/agents/) | [Browse CIS](https://bmad-code-org.github.io/bmad-bundles/cis/agents/) | [Browse BMGD](https://bmad-code-org.github.io/bmad-bundles/bmgd/agents/) - ---- - -## Stable vs Latest - -**Stable (GitHub Releases):** - -- Production-ready, tested releases -- Version-pinned (v6.0.0, etc.) -- Download: `https://github.com/bmad-code-org/BMAD-METHOD/releases/latest` - -**Latest (GitHub Pages):** - -- Bleeding edge (main branch) -- Auto-updated on every merge -- Browse: `https://bmad-code-org.github.io/bmad-bundles/` - ---- - -## Full Installation (Recommended) - -For IDE integration with slash commands: - -```bash -npx bmad-method@alpha install -``` - -Gives you: - -- Slash commands (`/bmad:bmm:workflows:prd`) -- 34+ workflows (not just agents) -- Status tracking (workflow-status.yaml) -- Local customization - ---- - -## Troubleshooting - -**ChatGPT: "File too large"** -→ Some agents (PM: 166KB, Analyst: 211KB) exceed ChatGPT limits. Use smaller agents or report issue. - -**Bundle not loading** -→ Use raw URL (not GitHub UI link). URL should end in `.xml`. - -**Out of date** -→ Wait 2-3 min after main merge, then refresh. - ---- - -**Issues?** Report at https://github.com/bmad-code-org/BMAD-METHOD/issues diff --git a/docs/v4-to-v6-upgrade.md b/docs/v4-to-v6-upgrade.md index 3af68bc7..0becbdad 100644 --- a/docs/v4-to-v6-upgrade.md +++ b/docs/v4-to-v6-upgrade.md @@ -93,7 +93,7 @@ After running the v6 installer: - This tells v6 you've already completed planning and solutioning phases 3. **Document paths**: Keep your existing paths during installation - Default PRD/Architecture location: `docs/` - - Default stories location: `docs/stories/` + - Default stories location: `docs/sprint-artifacts/` - **Accept these defaults** if you're already using them in v4 > **Important**: v6 workflows can handle both sharded and unsharded documents. You don't need to restructure your existing PRD or architecture files. @@ -188,7 +188,7 @@ The installer will: If you're using: - `docs/` for PRD and architecture -- `docs/stories/` for story files +- `docs/sprint-artifacts/` for story files **Accept these defaults** during installation. diff --git a/src/modules/bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml b/src/modules/bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml index a35f50c3..f058e797 100644 --- a/src/modules/bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml +++ b/src/modules/bmgd/workflows/4-production/sprint-planning/sprint-status-template.yaml @@ -38,7 +38,7 @@ generated: 05-06-2-2025 21:30 project: My Awesome Project project_key: jira-1234 tracking_system: file-system -story_location: "{project-root}/docs/stories" +story_location: "{story_location}" development_status: epic-1: contexted diff --git a/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml b/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml index 08859887..e1e8624a 100644 --- a/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml @@ -23,7 +23,7 @@ variables: # Tracking system configuration tracking_system: "file-system" # Options: file-system, Future will support other options from config of mcp such as jira, linear, trello - story_location: "{project-root}/docs/stories" # Relative path for file-system, Future will support URL for Jira/Linear/Trello + story_location: "{config_source}:sprint_artifacts" # Relative path for file-system, Future will support URL for Jira/Linear/Trello story_location_absolute: "{config_source}:sprint_artifacts" # Absolute path for file operations # Source files (file-system only) diff --git a/src/modules/bmm/_module-installer/install-config.yaml b/src/modules/bmm/_module-installer/install-config.yaml index be12268d..901027e3 100644 --- a/src/modules/bmm/_module-installer/install-config.yaml +++ b/src/modules/bmm/_module-installer/install-config.yaml @@ -37,7 +37,7 @@ user_skill_level: sprint_artifacts: prompt: "Where should Sprint Artifacts be stored (sprint status, stories, story context, temp context, etc...)?" - default: "{output_folder}/stories" + default: "{output_folder}/sprint-artifacts" result: "{project-root}/{value}" # TEA Agent Configuration diff --git a/src/modules/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml b/src/modules/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml index a35f50c3..f058e797 100644 --- a/src/modules/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +++ b/src/modules/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml @@ -38,7 +38,7 @@ generated: 05-06-2-2025 21:30 project: My Awesome Project project_key: jira-1234 tracking_system: file-system -story_location: "{project-root}/docs/stories" +story_location: "{story_location}" development_status: epic-1: contexted diff --git a/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml b/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml index 9ee85697..fa635951 100644 --- a/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml @@ -23,7 +23,7 @@ variables: # Tracking system configuration tracking_system: "file-system" # Options: file-system, Future will support other options from config of mcp such as jira, linear, trello - story_location: "{project-root}/docs/stories" # Relative path for file-system, Future will support URL for Jira/Linear/Trello + story_location: "{config_source}:sprint_artifacts" # Relative path for file-system, Future will support URL for Jira/Linear/Trello story_location_absolute: "{config_source}:sprint_artifacts" # Absolute path for file operations # Source files (file-system only)