From d0c9cd7b0be565509390cdacac806cceb6e35747 Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Sun, 25 Jan 2026 22:23:36 -0600 Subject: [PATCH] removed dead code and obsolete levels 0-4 ref --- docs/_STYLE_GUIDE.md | 94 +++++++++---------- docs/explanation/brownfield-faq.md | 12 --- docs/how-to/brownfield/index.md | 6 +- .../quick-dev/data/project-levels.yaml | 59 ------------ .../kebab-case-triggers.agent.yaml | 2 +- 5 files changed, 52 insertions(+), 121 deletions(-) delete mode 100644 src/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml diff --git a/docs/_STYLE_GUIDE.md b/docs/_STYLE_GUIDE.md index 4966ec3a..e5fb51ff 100644 --- a/docs/_STYLE_GUIDE.md +++ b/docs/_STYLE_GUIDE.md @@ -6,17 +6,17 @@ This project adheres to the [Google Developer Documentation Style Guide](https:/ ## Project-Specific Rules -| Rule | Specification | -|------|---------------| -| No horizontal rules (`---`) | Fragments reading flow | -| No `####` headers | Use bold text or admonitions instead | -| No "Related" or "Next:" sections | Sidebar handles navigation | -| No deeply nested lists | Break into sections instead | -| No code blocks for non-code | Use admonitions for dialogue examples | -| No bold paragraphs for callouts | Use admonitions instead | -| 1-2 admonitions per section max | Tutorials allow 3-4 per major section | -| Table cells / list items | 1-2 sentences max | -| Header budget | 8-12 `##` per doc; 2-3 `###` per section | +| Rule | Specification | +| -------------------------------- | ---------------------------------------- | +| No horizontal rules (`---`) | Fragments reading flow | +| No `####` headers | Use bold text or admonitions instead | +| No "Related" or "Next:" sections | Sidebar handles navigation | +| No deeply nested lists | Break into sections instead | +| No code blocks for non-code | Use admonitions for dialogue examples | +| No bold paragraphs for callouts | Use admonitions instead | +| 1-2 admonitions per section max | Tutorials allow 3-4 per major section | +| Table cells / list items | 1-2 sentences max | +| Header budget | 8-12 `##` per doc; 2-3 `###` per section | ## Admonitions (Starlight Syntax) @@ -40,31 +40,31 @@ Critical warnings only — data loss, security issues ### Standard Uses -| Admonition | Use For | -|------------|---------| -| `:::note[Prerequisites]` | Dependencies before starting | -| `:::tip[Quick Path]` | TL;DR summary at document top | -| `:::caution[Important]` | Critical caveats | -| `:::note[Example]` | Command/response examples | +| Admonition | Use For | +| ------------------------ | ----------------------------- | +| `:::note[Prerequisites]` | Dependencies before starting | +| `:::tip[Quick Path]` | TL;DR summary at document top | +| `:::caution[Important]` | Critical caveats | +| `:::note[Example]` | Command/response examples | ## Standard Table Formats **Phases:** ```md -| Phase | Name | What Happens | -|-------|------|--------------| -| 1 | Analysis | Brainstorm, research *(optional)* | -| 2 | Planning | Requirements — PRD or tech-spec *(required)* | +| Phase | Name | What Happens | +| ----- | -------- | -------------------------------------------- | +| 1 | Analysis | Brainstorm, research *(optional)* | +| 2 | Planning | Requirements — PRD or tech-spec *(required)* | ``` **Commands:** ```md -| Command | Agent | Purpose | -|---------|-------|---------| -| `*workflow-init` | Analyst | Initialize a new project | -| `*prd` | PM | Create Product Requirements Document | +| Command | Agent | Purpose | +| ------------ | ------- | ------------------------------------ | +| `brainstorm` | Analyst | Brainstorm a new project | +| `prd` | PM | Create Product Requirements Document | ``` ## Folder Structure Blocks @@ -141,13 +141,13 @@ 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` | -| **FAQ** | `brownfield-faq.md` | +| Type | Example | +| ----------------- | ---------------------------- | +| **Index/Landing** | `core-concepts/index.md` | +| **Concept** | `what-are-agents.md` | +| **Feature** | `quick-flow.md` | +| **Philosophy** | `why-solutioning-matters.md` | +| **FAQ** | `brownfield-faq.md` | ### General Template @@ -217,14 +217,14 @@ your-project/ ### Types -| Type | Example | -|------|---------| -| **Index/Landing** | `workflows/index.md` | -| **Catalog** | `agents/index.md` | -| **Deep-Dive** | `document-project.md` | -| **Configuration** | `core-tasks.md` | -| **Glossary** | `glossary/index.md` | -| **Comprehensive** | `bmgd-workflows.md` | +| Type | Example | +| ----------------- | --------------------- | +| **Index/Landing** | `workflows/index.md` | +| **Catalog** | `agents/index.md` | +| **Deep-Dive** | `document-project.md` | +| **Configuration** | `core-tasks.md` | +| **Glossary** | `glossary/index.md` | +| **Comprehensive** | `bmgd-workflows.md` | ### Reference Index Pages @@ -303,19 +303,19 @@ Starlight generates right-side "On this page" navigation from headers: ```md ## Category Name -| Term | Definition | -|------|------------| -| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. | +| Term | Definition | +| ------------ | ---------------------------------------------------------------------------------------- | +| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. | | **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. | ``` ### Definition Rules -| Do | Don't | -|----|-------| +| Do | Don't | +| ----------------------------- | ------------------------------------------- | | Start with what it IS or DOES | Start with "This is..." or "A [term] is..." | -| Keep to 1-2 sentences | Write multi-paragraph explanations | -| Bold term name in cell | Use plain text for terms | +| Keep to 1-2 sentences | Write multi-paragraph explanations | +| Bold term name in cell | Use plain text for terms | ### Context Markers diff --git a/docs/explanation/brownfield-faq.md b/docs/explanation/brownfield-faq.md index 2e607d0e..1c9b3b82 100644 --- a/docs/explanation/brownfield-faq.md +++ b/docs/explanation/brownfield-faq.md @@ -11,7 +11,6 @@ Quick answers to common questions about brownfield (existing codebase) developme - [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield) - [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project) - [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects) - - [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs) - [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices) ### What is brownfield vs greenfield? @@ -44,17 +43,6 @@ Yes! Quick Spec Flow works great for brownfield. It will: Perfect for bug fixes and small features in existing codebases. -### How does workflow-init handle old planning docs? - -workflow-init asks about YOUR current work first, then uses old artifacts as context: - -1. Shows what it found (old PRD, epics, etc.) -2. Asks: "Is this work in progress, previous effort, or proposed work?" -3. If previous effort: Asks you to describe your NEW work -4. Determines level based on YOUR work, not old artifacts - -This prevents old Level 3 PRDs from forcing Level 3 workflow for a new Level 0 bug fix. - ### What if my existing code doesn't follow best practices? Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide: diff --git a/docs/how-to/brownfield/index.md b/docs/how-to/brownfield/index.md index d1fc6f3f..75bab690 100644 --- a/docs/how-to/brownfield/index.md +++ b/docs/how-to/brownfield/index.md @@ -36,9 +36,11 @@ Your `docs/` folder should contain succinct, well-organized documentation that a 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. -## Step 3: Initialize for Brownfield Work +## Step 3: Get Help -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. +Get help to know what to do next based on your unique needs + +Run `bmad-help` to get guidance when you are not sure what to do next. ### Choosing Your Approach diff --git a/src/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml b/src/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml deleted file mode 100644 index 628573ec..00000000 --- a/src/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +++ /dev/null @@ -1,59 +0,0 @@ -# BMM Project Scale Levels - Source of Truth -# Reference: /_bmad/bmm/README.md lines 77-85 - -levels: - 0: - name: "Level 0" - title: "Single Atomic Change" - stories: "1 story" - description: "Bug fix, tiny feature, one small change" - documentation: "Minimal - tech spec only" - architecture: false - - 1: - name: "Level 1" - title: "Small Feature" - stories: "1-10 stories" - description: "Small coherent feature, minimal documentation" - documentation: "Tech spec" - architecture: false - - 2: - name: "Level 2" - title: "Medium Project" - stories: "5-15 stories" - description: "Multiple features, focused PRD" - documentation: "PRD + optional tech spec" - architecture: false - - 3: - name: "Level 3" - title: "Complex System" - stories: "12-40 stories" - description: "Subsystems, integrations, full architecture" - documentation: "PRD + architecture + JIT tech specs" - architecture: true - - 4: - name: "Level 4" - title: "Enterprise Scale" - stories: "40+ stories" - description: "Multiple products, enterprise architecture" - documentation: "PRD + architecture + JIT tech specs" - architecture: true - -# Quick detection hints for workflow-init -detection_hints: - keywords: - level_0: ["fix", "bug", "typo", "small change", "quick update", "patch"] - level_1: ["simple", "basic", "small feature", "add", "minor"] - level_2: ["dashboard", "several features", "admin panel", "medium"] - level_3: ["platform", "integration", "complex", "system", "architecture"] - level_4: ["enterprise", "multi-tenant", "multiple products", "ecosystem", "scale"] - - story_counts: - level_0: [1, 1] - level_1: [1, 10] - level_2: [5, 15] - level_3: [12, 40] - level_4: [40, 999] diff --git a/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml b/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml index 06184350..cfae4fde 100644 --- a/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml @@ -23,7 +23,7 @@ agent: - trigger: list-tasks description: Two word trigger action: list_tasks - - trigger: workflow-init-process + - trigger: three-word-process description: Three word trigger action: init_workflow - trigger: test123