removed bad template updates from previous autoformatter

This commit is contained in:
Brian Madison
2025-06-17 21:40:59 -05:00
parent e8208ec277
commit bc7cc0439a
6 changed files with 120 additions and 117 deletions

View File

@@ -68,7 +68,7 @@ The epic numbering starts at 1 and increments for each epic found.
### Before (PRD): ### Before (PRD):
`````markdown ```markdown
# Product Requirements Document # Product Requirements Document
## 1. Executive Summary ## 1. Executive Summary
@@ -91,9 +91,10 @@ Epic content...
Content here... Content here...
````text ```
### After (PRD): ### After (PRD):
```markdown ```markdown
# Product Requirements Document # Product Requirements Document
@@ -113,9 +114,11 @@ Epic content...
## Success Metrics ## Success Metrics
Content here... Content here...
```text
```
### Before (Non-PRD): ### Before (Non-PRD):
```markdown ```markdown
# Architecture Document # Architecture Document
@@ -124,9 +127,10 @@ Content...
## 2.1 Technical Stack & Tools ## 2.1 Technical Stack & Tools
Content... Content...
```text ```
### After (Non-PRD): ### After (Non-PRD):
```markdown ```markdown
# Architecture Document # Architecture Document
@@ -135,9 +139,5 @@ Content...
## Technical Stack Tools ## Technical Stack Tools
Content... Content...
````
`````
```text
``` ```

View File

@@ -56,7 +56,7 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
The index should be organized as follows: The index should be organized as follows:
`````markdown ```markdown
# Documentation Index # Documentation Index
## Root Documents ## Root Documents
@@ -89,7 +89,7 @@ Documents within the `another-folder/` directory:
Description of nested document. Description of nested document.
````text ```
### Index Entry Format ### Index Entry Format
@@ -99,10 +99,7 @@ Each entry should follow this format:
### [Document Title](relative/path/to/file.md) ### [Document Title](relative/path/to/file.md)
Brief description of the document's purpose and contents. Brief description of the document's purpose and contents.
```` ```
`````
````
### Rules of Operation ### Rules of Operation
@@ -180,4 +177,3 @@ Please provide:
5. Whether to include hidden files/folders (starting with `.`) 5. Whether to include hidden files/folders (starting with `.`)
Would you like to proceed with documentation indexing? Please provide the required input above. Would you like to proceed with documentation indexing? Please provide the required input above.
````

View File

@@ -109,9 +109,9 @@ Document the choice and key services that will be used.]]
Use appropriate diagram type for clarity.]] Use appropriate diagram type for clarity.]]
````mermaid ```mermaid
{{architecture_diagram}} {{architecture_diagram}}
```text ```
### Architectural Patterns ### Architectural Patterns
@@ -222,7 +222,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
model_interface; model_interface;
} }
} }
```` ```
**Relationships:** **Relationships:**
@@ -246,7 +246,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
**TypeScript Interface:** **TypeScript Interface:**
````typescript ```typescript
interface User { interface User {
id: string; id: string;
email: string; email: string;
@@ -300,16 +300,16 @@ servers:
'[object Object]': null '[object Object]': null
description: description:
'[object Object]': null '[object Object]': null
```` ```
^^/CONDITION: has_rest_api^^ ^^/CONDITION: has_rest_api^^
^^CONDITION: has_graphql_api^^ ^^CONDITION: has_graphql_api^^
````graphql ```graphql
# GraphQL Schema # GraphQL Schema
{{graphql_schema}} {{graphql_schema}}
```text ```
^^/CONDITION: has_graphql_api^^ ^^/CONDITION: has_graphql_api^^
@@ -322,7 +322,7 @@ servers:
trpc_routers; trpc_routers;
} }
} }
```` ```
^^/CONDITION: has_trpc_api^^ ^^/CONDITION: has_trpc_api^^
@@ -467,19 +467,19 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Component Organization:** **Component Organization:**
`````text
{{component_structure}}
```text ```text
{{component_structure}}
```
**Component Template:** **Component Template:**
````typescript ```typescript
{ {
{ {
component_template; component_template;
} }
} }
```text ```
### State Management Architecture ### State Management Architecture
@@ -493,7 +493,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
state_structure; state_structure;
} }
} }
````` ```
**State Management Patterns:** **State Management Patterns:**
@@ -512,13 +512,13 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Protected Route Pattern:** **Protected Route Pattern:**
````typescript ```typescript
{ {
{ {
protected_route_example; protected_route_example;
} }
} }
```text ```
### Frontend Services Layer ### Frontend Services Layer
@@ -532,17 +532,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
api_client_setup; api_client_setup;
} }
} }
```` ```
**Service Example:** **Service Example:**
````typescript ```typescript
{ {
{ {
service_example; service_example;
} }
} }
```text ```
## Backend Architecture ## Backend Architecture
@@ -557,11 +557,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
^^CONDITION: serverless^^ ^^CONDITION: serverless^^
**Function Organization:** **Function Organization:**
```` ```text
{{function_structure}} {{function_structure}}
````text ```
**Function Template:** **Function Template:**
@@ -571,26 +571,26 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
function_template; function_template;
} }
} }
```` ```
^^/CONDITION: serverless^^ ^^/CONDITION: serverless^^
^^CONDITION: traditional_server^^ ^^CONDITION: traditional_server^^
**Controller/Route Organization:** **Controller/Route Organization:**
`````text
{{controller_structure}}
```text ```text
{{controller_structure}}
```
**Controller Template:** **Controller Template:**
````typescript ```typescript
{ {
{ {
controller_template; controller_template;
} }
} }
```text ```
^^/CONDITION: traditional_server^^ ^^/CONDITION: traditional_server^^
@@ -602,17 +602,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```sql ```sql
{{database_schema}} {{database_schema}}
````` ```
**Data Access Layer:** **Data Access Layer:**
````typescript ```typescript
{ {
{ {
repository_pattern; repository_pattern;
} }
} }
```text ```
### Authentication and Authorization ### Authentication and Authorization
@@ -622,17 +622,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```mermaid ```mermaid
{{auth_flow_diagram}} {{auth_flow_diagram}}
```` ```
**Middleware/Guards:** **Middleware/Guards:**
````typescript ```typescript
{ {
{ {
auth_middleware; auth_middleware;
} }
} }
```text ```
## Unified Project Structure ## Unified Project Structure
@@ -692,7 +692,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
├── package.json # Root package.json ├── package.json # Root package.json
├── {{monorepo_config}} # Monorepo configuration ├── {{monorepo_config}} # Monorepo configuration
└── README.md └── README.md
```` ```
@{example: vercel_structure} @{example: vercel_structure}
apps/ apps/
@@ -714,19 +714,19 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Prerequisites:** **Prerequisites:**
````bash ```bash
{{prerequisites_commands}} {{prerequisites_commands}}
```text ```
**Initial Setup:** **Initial Setup:**
```bash ```bash
{{setup_commands}} {{setup_commands}}
```` ```
**Development Commands:** **Development Commands:**
````bash ```bash
# Start all services # Start all services
{{start_all_command}} {{start_all_command}}
@@ -738,7 +738,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
# Run tests # Run tests
{{test_commands}} {{test_commands}}
```text ```
### Environment Configuration ### Environment Configuration
@@ -753,7 +753,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
# Shared # Shared
{{shared_env_vars}} {{shared_env_vars}}
```` ```
## Deployment Architecture ## Deployment Architecture
@@ -776,9 +776,9 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### CI/CD Pipeline ### CI/CD Pipeline
````yaml ```yaml
'[object Object]': null '[object Object]': null
```text ```
### Environments ### Environments
@@ -836,7 +836,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### Testing Pyramid ### Testing Pyramid
```` ```text
E2E Tests E2E Tests
/ \ / \
@@ -845,17 +845,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
/ \ / \
Frontend Unit Backend Unit Frontend Unit Backend Unit
```text ```
### Test Organization ### Test Organization
**Frontend Tests:** **Frontend Tests:**
``` ```text
{{frontend_test_structure}} {{frontend_test_structure}}
````text ```
**Backend Tests:** **Backend Tests:**
@@ -863,15 +863,15 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
{{backend_test_structure}} {{backend_test_structure}}
```text ```
**E2E Tests:** **E2E Tests:**
```` ```text
{{e2e_test_structure}} {{e2e_test_structure}}
````text ```
### Test Examples ### Test Examples
@@ -883,17 +883,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
frontend_test_example; frontend_test_example;
} }
} }
```` ```
**Backend API Test:** **Backend API Test:**
````typescript ```typescript
{ {
{ {
backend_test_example; backend_test_example;
} }
} }
```text ```
**E2E Test:** **E2E Test:**
@@ -903,7 +903,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
e2e_test_example; e2e_test_example;
} }
} }
```` ```
## Coding Standards ## Coding Standards
@@ -944,9 +944,9 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### Error Flow ### Error Flow
````mermaid ```mermaid
{{error_flow_diagram}} {{error_flow_diagram}}
```text ```
### Error Response Format ### Error Response Format
@@ -960,17 +960,17 @@ interface ApiError {
requestId: string; requestId: string;
}; };
} }
```` ```
### Frontend Error Handling ### Frontend Error Handling
````typescript ```typescript
{ {
{ {
frontend_error_handler; frontend_error_handler;
} }
} }
```text ```
### Backend Error Handling ### Backend Error Handling
@@ -980,7 +980,7 @@ interface ApiError {
backend_error_handler; backend_error_handler;
} }
} }
```` ```
## Monitoring and Observability ## Monitoring and Observability

View File

@@ -137,13 +137,13 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
**TypeScript Interface:** **TypeScript Interface:**
````typescript ```typescript
{ {
{ {
model_interface; model_interface;
} }
} }
```text ```
**Relationships:** **Relationships:**
@@ -183,7 +183,7 @@ interface UserProfile {
bio?: string; bio?: string;
preferences: Record<string, any>; preferences: Record<string, any>;
} }
```` ```
**Relationships:** **Relationships:**
@@ -207,7 +207,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site),
^^CONDITION: has_rest_api^^ ^^CONDITION: has_rest_api^^
````yml ```yml
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: title:
@@ -221,7 +221,7 @@ servers:
'[object Object]': null '[object Object]': null
description: description:
'[object Object]': null '[object Object]': null
```text ```
^^/CONDITION: has_rest_api^^ ^^/CONDITION: has_rest_api^^
@@ -230,7 +230,7 @@ servers:
```graphql ```graphql
# GraphQL Schema # GraphQL Schema
{{graphql_schema}} {{graphql_schema}}
```` ```
^^/CONDITION: has_graphql_api^^ ^^/CONDITION: has_graphql_api^^

View File

@@ -8,11 +8,11 @@ The easiest way to release new versions is through **automatic semantic releases
Use these prefixes to control what type of release happens: Use these prefixes to control what type of release happens:
````bash ```bash
fix: resolve CLI argument parsing bug # → patch release (4.1.0 → 4.1.1) fix: resolve CLI argument parsing bug # → patch release (4.1.0 → 4.1.1)
feat: add new agent orchestration mode # → minor release (4.1.0 → 4.2.0) feat: add new agent orchestration mode # → minor release (4.1.0 → 4.2.0)
feat!: redesign CLI interface # → major release (4.1.0 → 5.0.0) feat!: redesign CLI interface # → major release (4.1.0 → 5.0.0)
```text ```
### What Happens Automatically ### What Happens Automatically
@@ -35,24 +35,24 @@ git push
# That's it! Release happens automatically 🎉 # That's it! Release happens automatically 🎉
# Users can now run: npx bmad-method (and get the new version) # Users can now run: npx bmad-method (and get the new version)
```` ```
### Commits That DON'T Trigger Releases ### Commits That DON'T Trigger Releases
These commit types won't create releases (use them for maintenance): These commit types won't create releases (use them for maintenance):
````bash ```bash
chore: update dependencies # No release chore: update dependencies # No release
docs: fix typo in readme # No release docs: fix typo in readme # No release
style: format code # No release style: format code # No release
test: add unit tests # No release test: add unit tests # No release
```text ```
### Test Your Setup ### Test Your Setup
```bash ```bash
npm run release:test # Safe to run locally - tests the config npm run release:test # Safe to run locally - tests the config
```` ```
--- ---

View File

@@ -149,7 +149,7 @@ Create `expansion-packs/{pack-name}/plan.md` with:
## Approval ## Approval
User approval received: [ ] Yes User approval received: [ ] Yes
```text ```
Important: Wait for user approval before proceeding to Phase 2 Important: Wait for user approval before proceeding to Phase 2
@@ -282,6 +282,7 @@ IMPORTANT: Only proceed after plan.md is approved
#### 3.1 Create Directory Structure #### 3.1 Create Directory Structure
``` ```
expansion-packs/ expansion-packs/
└── {pack-name}/ └── {pack-name}/
├── plan.md (ALREADY CREATED) ├── plan.md (ALREADY CREATED)
@@ -309,7 +310,8 @@ expansion-packs/
│ └── {domain}-workflow.md (REQUIRED if multiple agents) │ └── {domain}-workflow.md (REQUIRED if multiple agents)
└── agent-teams/ └── agent-teams/
└── {domain}-team.yml (REQUIRED if multiple agents) └── {domain}-team.yml (REQUIRED if multiple agents)
```text
```
#### 3.2 Create Manifest #### 3.2 Create Manifest
@@ -445,7 +447,7 @@ cp bmad-core/tasks/execute-checklist.md expansion-packs/{pack-name}/tasks/
mkdir -p expansion-packs/{pack-name}/utils mkdir -p expansion-packs/{pack-name}/utils
cp bmad-core/utils/template-format.md expansion-packs/{pack-name}/utils/ cp bmad-core/utils/template-format.md expansion-packs/{pack-name}/utils/
cp bmad-core/utils/workflow-management.md expansion-packs/{pack-name}/utils/ cp bmad-core/utils/workflow-management.md expansion-packs/{pack-name}/utils/
```text ```
**Step 3: Technical Implementation** **Step 3: Technical Implementation**
@@ -695,10 +697,10 @@ _{Professional background and expertise}_
- `{file2}.{ext}` - {description} - `{file2}.{ext}` - {description}
2. **Launch Orchestrator**: 2. **Launch Orchestrator**:
```bash ```bash
npm run agent {pack-name}-orchestrator npm run agent {pack-name}-orchestrator
``` ```
````
3. **Follow Numbered Options**: {Character Name} will present numbered choices for each decision 3. **Follow Numbered Options**: {Character Name} will present numbered choices for each decision
@@ -728,14 +730,12 @@ _{Professional background and expertise}_
### Knowledge Base ### Knowledge Base
[Embedded domain expertise] [Embedded domain expertise]
```` ````
#### 6.3 Advanced Data File Documentation with Validation #### 6.3 Advanced Data File Documentation with Validation
For each required data file, provide comprehensive guidance: For each required data file, provide comprehensive guidance:
```markdown
## Required User Data Files ## Required User Data Files
### {filename}.{ext} ### {filename}.{ext}
@@ -745,7 +745,6 @@ For each required data file, provide comprehensive guidance:
- **Location**: Place in `bmad-core/data/` - **Location**: Place in `bmad-core/data/`
- **Validation**: {how agents will verify the file is correct} - **Validation**: {how agents will verify the file is correct}
- **Example Structure**: - **Example Structure**:
````
{sample content showing exact format} {sample content showing exact format}
@@ -1021,3 +1020,11 @@ Embedded knowledge (automatic):
- [ ] Template conditional content tested with different scenarios - [ ] Template conditional content tested with different scenarios
- [ ] Workflow decision trees validated with sample use cases - [ ] Workflow decision trees validated with sample use cases
- [ ] Character interactions tested for consistency and professional authenticity - [ ] Character interactions tested for consistency and professional authenticity
```
```
```
```