Skip to content

Commit d0c9cd7

Browse files
Brian MadisonBrian Madison
authored andcommitted
removed dead code and obsolete levels 0-4 ref
1 parent c352e03 commit d0c9cd7

File tree

5 files changed

+52
-121
lines changed

5 files changed

+52
-121
lines changed

docs/_STYLE_GUIDE.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ This project adheres to the [Google Developer Documentation Style Guide](https:/
66

77
## Project-Specific Rules
88

9-
| Rule | Specification |
10-
|------|---------------|
11-
| No horizontal rules (`---`) | Fragments reading flow |
12-
| No `####` headers | Use bold text or admonitions instead |
13-
| No "Related" or "Next:" sections | Sidebar handles navigation |
14-
| No deeply nested lists | Break into sections instead |
15-
| No code blocks for non-code | Use admonitions for dialogue examples |
16-
| No bold paragraphs for callouts | Use admonitions instead |
17-
| 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
18-
| Table cells / list items | 1-2 sentences max |
19-
| Header budget | 8-12 `##` per doc; 2-3 `###` per section |
9+
| Rule | Specification |
10+
| -------------------------------- | ---------------------------------------- |
11+
| No horizontal rules (`---`) | Fragments reading flow |
12+
| No `####` headers | Use bold text or admonitions instead |
13+
| No "Related" or "Next:" sections | Sidebar handles navigation |
14+
| No deeply nested lists | Break into sections instead |
15+
| No code blocks for non-code | Use admonitions for dialogue examples |
16+
| No bold paragraphs for callouts | Use admonitions instead |
17+
| 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
18+
| Table cells / list items | 1-2 sentences max |
19+
| Header budget | 8-12 `##` per doc; 2-3 `###` per section |
2020

2121
## Admonitions (Starlight Syntax)
2222

@@ -40,31 +40,31 @@ Critical warnings only — data loss, security issues
4040

4141
### Standard Uses
4242

43-
| Admonition | Use For |
44-
|------------|---------|
45-
| `:::note[Prerequisites]` | Dependencies before starting |
46-
| `:::tip[Quick Path]` | TL;DR summary at document top |
47-
| `:::caution[Important]` | Critical caveats |
48-
| `:::note[Example]` | Command/response examples |
43+
| Admonition | Use For |
44+
| ------------------------ | ----------------------------- |
45+
| `:::note[Prerequisites]` | Dependencies before starting |
46+
| `:::tip[Quick Path]` | TL;DR summary at document top |
47+
| `:::caution[Important]` | Critical caveats |
48+
| `:::note[Example]` | Command/response examples |
4949

5050
## Standard Table Formats
5151

5252
**Phases:**
5353

5454
```md
55-
| Phase | Name | What Happens |
56-
|-------|------|--------------|
57-
| 1 | Analysis | Brainstorm, research *(optional)* |
58-
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
55+
| Phase | Name | What Happens |
56+
| ----- | -------- | -------------------------------------------- |
57+
| 1 | Analysis | Brainstorm, research *(optional)* |
58+
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
5959
```
6060

6161
**Commands:**
6262

6363
```md
64-
| Command | Agent | Purpose |
65-
|---------|-------|---------|
66-
| `*workflow-init` | Analyst | Initialize a new project |
67-
| `*prd` | PM | Create Product Requirements Document |
64+
| Command | Agent | Purpose |
65+
| ------------ | ------- | ------------------------------------ |
66+
| `brainstorm` | Analyst | Brainstorm a new project |
67+
| `prd` | PM | Create Product Requirements Document |
6868
```
6969

7070
## Folder Structure Blocks
@@ -141,13 +141,13 @@ your-project/
141141

142142
### Types
143143

144-
| Type | Example |
145-
|------|---------|
146-
| **Index/Landing** | `core-concepts/index.md` |
147-
| **Concept** | `what-are-agents.md` |
148-
| **Feature** | `quick-flow.md` |
149-
| **Philosophy** | `why-solutioning-matters.md` |
150-
| **FAQ** | `brownfield-faq.md` |
144+
| Type | Example |
145+
| ----------------- | ---------------------------- |
146+
| **Index/Landing** | `core-concepts/index.md` |
147+
| **Concept** | `what-are-agents.md` |
148+
| **Feature** | `quick-flow.md` |
149+
| **Philosophy** | `why-solutioning-matters.md` |
150+
| **FAQ** | `brownfield-faq.md` |
151151

152152
### General Template
153153

@@ -217,14 +217,14 @@ your-project/
217217

218218
### Types
219219

220-
| Type | Example |
221-
|------|---------|
222-
| **Index/Landing** | `workflows/index.md` |
223-
| **Catalog** | `agents/index.md` |
224-
| **Deep-Dive** | `document-project.md` |
225-
| **Configuration** | `core-tasks.md` |
226-
| **Glossary** | `glossary/index.md` |
227-
| **Comprehensive** | `bmgd-workflows.md` |
220+
| Type | Example |
221+
| ----------------- | --------------------- |
222+
| **Index/Landing** | `workflows/index.md` |
223+
| **Catalog** | `agents/index.md` |
224+
| **Deep-Dive** | `document-project.md` |
225+
| **Configuration** | `core-tasks.md` |
226+
| **Glossary** | `glossary/index.md` |
227+
| **Comprehensive** | `bmgd-workflows.md` |
228228

229229
### Reference Index Pages
230230

@@ -303,19 +303,19 @@ Starlight generates right-side "On this page" navigation from headers:
303303
```md
304304
## Category Name
305305

306-
| Term | Definition |
307-
|------|------------|
308-
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
306+
| Term | Definition |
307+
| ------------ | ---------------------------------------------------------------------------------------- |
308+
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
309309
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
310310
```
311311

312312
### Definition Rules
313313

314-
| Do | Don't |
315-
|----|-------|
314+
| Do | Don't |
315+
| ----------------------------- | ------------------------------------------- |
316316
| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
317-
| Keep to 1-2 sentences | Write multi-paragraph explanations |
318-
| Bold term name in cell | Use plain text for terms |
317+
| Keep to 1-2 sentences | Write multi-paragraph explanations |
318+
| Bold term name in cell | Use plain text for terms |
319319

320320
### Context Markers
321321

docs/explanation/brownfield-faq.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Quick answers to common questions about brownfield (existing codebase) developme
1111
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
1212
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
1313
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
14-
- [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs)
1514
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
1615

1716
### What is brownfield vs greenfield?
@@ -44,17 +43,6 @@ Yes! Quick Spec Flow works great for brownfield. It will:
4443

4544
Perfect for bug fixes and small features in existing codebases.
4645

47-
### How does workflow-init handle old planning docs?
48-
49-
workflow-init asks about YOUR current work first, then uses old artifacts as context:
50-
51-
1. Shows what it found (old PRD, epics, etc.)
52-
2. Asks: "Is this work in progress, previous effort, or proposed work?"
53-
3. If previous effort: Asks you to describe your NEW work
54-
4. Determines level based on YOUR work, not old artifacts
55-
56-
This prevents old Level 3 PRDs from forcing Level 3 workflow for a new Level 0 bug fix.
57-
5846
### What if my existing code doesn't follow best practices?
5947

6048
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:

docs/how-to/brownfield/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
3636

3737
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
3838

39-
## Step 3: Initialize for Brownfield Work
39+
## Step 3: Get Help
4040

41-
Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
41+
Get help to know what to do next based on your unique needs
42+
43+
Run `bmad-help` to get guidance when you are not sure what to do next.
4244

4345
### Choosing Your Approach
4446

src/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml

Lines changed: 0 additions & 59 deletions
This file was deleted.

test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ agent:
2323
- trigger: list-tasks
2424
description: Two word trigger
2525
action: list_tasks
26-
- trigger: workflow-init-process
26+
- trigger: three-word-process
2727
description: Three word trigger
2828
action: init_workflow
2929
- trigger: test123

0 commit comments

Comments
 (0)