From 98c1fa8282df16879cf06dfe6e5839f17e49693c Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Thu, 12 Feb 2026 12:52:13 -0600 Subject: [PATCH 1/3] document project remove legacy workflow init and workflow- status function calls --- docs/_STYLE_GUIDE.md | 13 +- .../document-project/instructions.md | 115 ++---------------- 2 files changed, 18 insertions(+), 110 deletions(-) diff --git a/docs/_STYLE_GUIDE.md b/docs/_STYLE_GUIDE.md index 801314cd0..f9b38ed86 100644 --- a/docs/_STYLE_GUIDE.md +++ b/docs/_STYLE_GUIDE.md @@ -78,7 +78,6 @@ your-project/ ├── _bmad/ # BMad configuration ├── _bmad-output/ │ ├── PRD.md # Your requirements document -│ └── bmm-workflow-status.yaml # Progress tracking └── ... ``` ```` @@ -142,12 +141,12 @@ your-project/ ### Types -| Type | Example | -| ----------------- | ---------------------------- | -| **Index/Landing** | `core-concepts/index.md` | -| **Concept** | `what-are-agents.md` | -| **Feature** | `quick-flow.md` | -| **Philosophy** | `why-solutioning-matters.md` | +| Type | Example | +| ----------------- | ----------------------------- | +| **Index/Landing** | `core-concepts/index.md` | +| **Concept** | `what-are-agents.md` | +| **Feature** | `quick-flow.md` | +| **Philosophy** | `why-solutioning-matters.md` | | **FAQ** | `established-projects-faq.md` | ### General Template diff --git a/src/bmm/workflows/document-project/instructions.md b/src/bmm/workflows/document-project/instructions.md index 059134259..0354be610 100644 --- a/src/bmm/workflows/document-project/instructions.md +++ b/src/bmm/workflows/document-project/instructions.md @@ -8,55 +8,7 @@ This router determines workflow mode and delegates to specialized sub-workflows - - - - mode: data - data_request: project_config - - - - {{suggestion}} - Note: Documentation workflow can run standalone. Continuing without progress tracking. - Set standalone_mode = true - Set status_file_found = false - - - - Store {{status_file_path}} for later updates - Set status_file_found = true - - - - Note: This is a greenfield project. Documentation workflow is typically for brownfield projects. - Continue anyway to document planning artifacts? (y/n) - - Exit workflow - - - - - - mode: validate - calling_workflow: document-project - - - - {{warning}} - Note: This may be auto-invoked by prd for brownfield documentation. - Continue with documentation? (y/n) - - {{suggestion}} - Exit workflow - - - - - - - -SMART LOADING STRATEGY: Check state file FIRST before loading any CSV files - + Check for existing state file at: {project_knowledge}/project-scan-report.json @@ -66,21 +18,21 @@ I found an in-progress workflow state from {{last_updated}}. -**Current Progress:** + **Current Progress:** -- Mode: {{mode}} -- Scan Level: {{scan_level}} -- Completed Steps: {{completed_steps_count}}/{{total_steps}} -- Last Step: {{current_step}} -- Project Type(s): {{cached_project_types}} + - Mode: {{mode}} + - Scan Level: {{scan_level}} + - Completed Steps: {{completed_steps_count}}/{{total_steps}} + - Last Step: {{current_step}} + - Project Type(s): {{cached_project_types}} -Would you like to: + Would you like to: -1. **Resume from where we left off** - Continue from step {{current_step}} -2. **Start fresh** - Archive old state and begin new scan -3. **Cancel** - Exit without changes + 1. **Resume from where we left off** - Continue from step {{current_step}} + 2. **Start fresh** - Archive old state and begin new scan + 3. **Cancel** - Exit without changes -Your choice [1/2/3]: + Your choice [1/2/3]: @@ -175,47 +127,4 @@ Your choice [1/2/3]: - - - - - mode: update - action: complete_workflow - workflow_name: document-project - - - - Status updated! - - - -**✅ Document Project Workflow Complete, {user_name}!** - -**Documentation Generated:** - -- Mode: {{workflow_mode}} -- Scan Level: {{scan_level}} -- Output: {project_knowledge}/index.md and related files - -{{#if status_file_found}} -**Status Updated:** - -- Progress tracking updated - -**Next Steps:** - -- **Next required:** {{next_workflow}} ({{next_agent}} agent) - -Check status anytime with: `workflow-status` -{{else}} -**Next Steps:** -Since no workflow is in progress: - -- Refer to the BMM workflow guide if unsure what to do next -- Or run `workflow-init` to create a workflow path and get guided next steps - {{/if}} - - - - From 5b5cb1a3964ba5caab03d3c420d8a5c47fbe4d8d Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Sat, 14 Feb 2026 21:25:58 -0600 Subject: [PATCH 2/3] modify post install notes example --- tools/cli/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/cli/README.md b/tools/cli/README.md index 8ba164d36..9e943d689 100644 --- a/tools/cli/README.md +++ b/tools/cli/README.md @@ -16,8 +16,8 @@ Always displayed after the module is configured: ```yaml post-install-notes: | - Remember to set the API_KEY environment variable. - See: https://example.com/setup + Thank you for choosing the XYZ Cool Module + For Support about this Module call 555-1212 ``` ### Conditional Format From a5e2b1c63a25b0070eb5aa5dd40132a96cec8d42 Mon Sep 17 00:00:00 2001 From: Ankit Gupta Date: Sun, 15 Feb 2026 13:59:11 +0000 Subject: [PATCH 3/3] docs: fix changelog URL in installer start message (#1660) Co-authored-by: Ankit Gupta --- tools/cli/installers/install-messages.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/cli/installers/install-messages.yaml b/tools/cli/installers/install-messages.yaml index 66e683a27..6138c7c2c 100644 --- a/tools/cli/installers/install-messages.yaml +++ b/tools/cli/installers/install-messages.yaml @@ -34,7 +34,7 @@ startMessage: | - Subscribe on YouTube: https://www.youtube.com/@BMadCode - Every star & sub helps us reach more developers! - Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/CHANGELOG.md + Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━