sepehr/Entropyk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update documentation to reflect recent architectural changes and improve clarity

Browse Source
This commit is contained in:
Sepehr
2026-03-10 22:59:04 +01:00
parent d88914a44f
commit 891c4ba436
530 changed files with 2544 additions and 1513 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md
View File

@@ -2,8 +2,6 @@
name: 'step-01-understand'
description: 'Analyze the requirement delta between current state and what user wants to build'
nextStepFile: './step-02-investigate.md'
skipToStepFile: './step-03-generate.md'
templateFile: '../tech-spec-template.md'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
@@ -56,9 +54,9 @@ a) **Menu Handling:**
- **[Y] Continue existing:**
- Jump directly to the appropriate step based on `stepsCompleted`:
- `[1]` → Load `{nextStepFile}` (Step 2)
- `[1, 2]` → Load `{skipToStepFile}` (Step 3)
- `[1, 2, 3]` → Load `./step-04-review.md` (Step 4)
- `[1]` → Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md` (Step 2)
- `[1, 2]` → Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md` (Step 3)
- `[1, 2, 3]` → Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md` (Step 4)
- **[N] Archive and start fresh:**
- Rename `{wipFile}` to `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md`
@@ -169,7 +167,7 @@ b) **HALT and wait for user selection.**
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF C: Verify `{wipFile}` has `stepsCompleted: [1]`, then read fully and follow: `{nextStepFile}`
- IF C: Verify `{wipFile}` has `stepsCompleted: [1]`, then read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md`
- IF Any other comments or queries: respond helpfully then redisplay menu
#### EXECUTION RULES:

3
_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md
View File

@@ -2,7 +2,6 @@
name: 'step-02-investigate'
description: 'Map technical constraints and anchor points within the codebase'
nextStepFile: './step-03-generate.md'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
@@ -122,7 +121,7 @@ Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Ge
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
- IF C: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{nextStepFile}`
- IF C: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md`
- IF Any other comments or queries: respond helpfully then redisplay menu
#### EXECUTION RULES:

3
_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md
View File

@@ -2,7 +2,6 @@
name: 'step-03-generate'
description: 'Build the implementation plan based on the technical mapping of constraints'
nextStepFile: './step-04-review.md'
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
---
@@ -113,7 +112,7 @@ stepsCompleted: [1, 2, 3]
---
```
c) **Read fully and follow: `{nextStepFile}` (Step 4)**
c) **Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md` (Step 4)**
## REQUIRED OUTPUTS:

4
_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md
View File

@@ -1,6 +1,6 @@
---
name: quick-spec
description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.
description: 'Very quick process to create implementation-ready quick specs for small changes or features. Use when the user says "create a quick spec" or "generate a quick tech spec"'
main_config: '{project-root}/_bmad/bmm/config.yaml'
# Checkpoint handler paths
@@ -76,4 +76,4 @@ Load and read full config from `{main_config}` and resolve:
### 2. First Step Execution
Read fully and follow: `steps/step-01-understand.md` to begin the workflow.
Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md` to begin the workflow.