ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

document project remove legacy workflow init and workflow- status function calls

This commit is contained in:
Brian Madison 2026-02-12 12:52:13 -06:00
parent ae7b3a7930
commit 98c1fa8282
2 changed files with 18 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/_STYLE_GUIDE.md
View File

@ -78,7 +78,6 @@ your-project/
├── _bmad/ # BMad configuration ├── _bmad/ # BMad configuration
├── _bmad-output/ ├── _bmad-output/
│ ├── PRD.md # Your requirements document │ ├── PRD.md # Your requirements document
│ └── bmm-workflow-status.yaml # Progress tracking
└── ... └── ...
``` ```
```` ````
@ -143,7 +142,7 @@ your-project/
### Types ### Types
| Type | Example | | Type | Example |
| ----------------- | ---------------------------- | | ----------------- | ----------------------------- |
| **Index/Landing** | `core-concepts/index.md` | | **Index/Landing** | `core-concepts/index.md` |
| **Concept** | `what-are-agents.md` | | **Concept** | `what-are-agents.md` |
| **Feature** | `quick-flow.md` | | **Feature** | `quick-flow.md` |

115
src/bmm/workflows/document-project/instructions.md
View File

@ -8,55 +8,7 @@
<critical>This router determines workflow mode and delegates to specialized sub-workflows</critical> <critical>This router determines workflow mode and delegates to specialized sub-workflows</critical>
<step n="1" goal="Validate workflow and get project info"> <step n="1" goal="Check for ability to resume and determine workflow mode">
<invoke-workflow path="{project-root}/_bmad/bmm/workflows/workflow-status">
<param>mode: data</param>
<param>data_request: project_config</param>
</invoke-workflow>
<check if="status_exists == false">
<output>{{suggestion}}</output>
<output>Note: Documentation workflow can run standalone. Continuing without progress tracking.</output>
<action>Set standalone_mode = true</action>
<action>Set status_file_found = false</action>
</check>
<check if="status_exists == true">
<action>Store {{status_file_path}} for later updates</action>
<action>Set status_file_found = true</action>
<!-- Extract brownfield/greenfield from status data -->
<check if="field_type == 'greenfield'">
<output>Note: This is a greenfield project. Documentation workflow is typically for brownfield projects.</output>
<ask>Continue anyway to document planning artifacts? (y/n)</ask>
<check if="n">
<action>Exit workflow</action>
</check>
</check>
<!-- Now validate sequencing -->
<invoke-workflow path="{project-root}/_bmad/bmm/workflows/workflow-status">
<param>mode: validate</param>
<param>calling_workflow: document-project</param>
</invoke-workflow>
<check if="warning != ''">
<output>{{warning}}</output>
<output>Note: This may be auto-invoked by prd for brownfield documentation.</output>
<ask>Continue with documentation? (y/n)</ask>
<check if="n">
<output>{{suggestion}}</output>
<action>Exit workflow</action>
</check>
</check>
</check>
</step>
<step n="2" goal="Check for resumability and determine workflow mode">
<critical>SMART LOADING STRATEGY: Check state file FIRST before loading any CSV files</critical>
<action>Check for existing state file at: {project_knowledge}/project-scan-report.json</action> <action>Check for existing state file at: {project_knowledge}/project-scan-report.json</action>
<check if="project-scan-report.json exists"> <check if="project-scan-report.json exists">
@ -66,21 +18,21 @@
<ask>I found an in-progress workflow state from {{last_updated}}. <ask>I found an in-progress workflow state from {{last_updated}}.
**Current Progress:** **Current Progress:**
- Mode: {{mode}} - Mode: {{mode}}
- Scan Level: {{scan_level}} - Scan Level: {{scan_level}}
- Completed Steps: {{completed_steps_count}}/{{total_steps}} - Completed Steps: {{completed_steps_count}}/{{total_steps}}
- Last Step: {{current_step}} - Last Step: {{current_step}}
- Project Type(s): {{cached_project_types}} - 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}} 1. **Resume from where we left off** - Continue from step {{current_step}}
2. **Start fresh** - Archive old state and begin new scan 2. **Start fresh** - Archive old state and begin new scan
3. **Cancel** - Exit without changes 3. **Cancel** - Exit without changes
Your choice [1/2/3]: Your choice [1/2/3]:
</ask> </ask>
<check if="user selects 1"> <check if="user selects 1">
@ -175,47 +127,4 @@ Your choice [1/2/3]:
</step> </step>
<step n="4" goal="Update status and complete">
<check if="status_file_found == true">
<invoke-workflow path="{project-root}/_bmad/bmm/workflows/workflow-status">
<param>mode: update</param>
<param>action: complete_workflow</param>
<param>workflow_name: document-project</param>
</invoke-workflow>
<check if="success == true">
<output>Status updated!</output>
</check>
</check>
<output>**✅ 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}}
</output>
</step>
</workflow> </workflow>