diff --git a/bmad-core/tasks/doc-migration-task.md b/bmad-core/tasks/doc-migration-task.md index ebceac4e..ca25725f 100644 --- a/bmad-core/tasks/doc-migration-task.md +++ b/bmad-core/tasks/doc-migration-task.md @@ -68,7 +68,7 @@ The epic numbering starts at 1 and increments for each epic found. ### Before (PRD): -`````markdown +```markdown # Product Requirements Document ## 1. Executive Summary @@ -91,9 +91,10 @@ Epic content... Content here... -````text +``` ### After (PRD): + ```markdown # Product Requirements Document @@ -113,9 +114,11 @@ Epic content... ## Success Metrics Content here... -```text + +``` ### Before (Non-PRD): + ```markdown # Architecture Document @@ -124,9 +127,10 @@ Content... ## 2.1 Technical Stack & Tools Content... -```text +``` ### After (Non-PRD): + ```markdown # Architecture Document @@ -135,9 +139,5 @@ Content... ## Technical Stack Tools Content... -```` -````` -```text - -``` +``` \ No newline at end of file diff --git a/bmad-core/tasks/index-docs.md b/bmad-core/tasks/index-docs.md index 9c0b4c44..3494de31 100644 --- a/bmad-core/tasks/index-docs.md +++ b/bmad-core/tasks/index-docs.md @@ -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: -`````markdown +```markdown # Documentation Index ## Root Documents @@ -89,7 +89,7 @@ Documents within the `another-folder/` directory: Description of nested document. -````text +``` ### Index Entry Format @@ -99,10 +99,7 @@ Each entry should follow this format: ### [Document Title](relative/path/to/file.md) Brief description of the document's purpose and contents. -```` -````` - -```` +``` ### Rules of Operation @@ -180,4 +177,3 @@ Please provide: 5. Whether to include hidden files/folders (starting with `.`) Would you like to proceed with documentation indexing? Please provide the required input above. -```` diff --git a/bmad-core/templates/fullstack-architecture-tmpl.md b/bmad-core/templates/fullstack-architecture-tmpl.md index 87526ac9..2a96be90 100644 --- a/bmad-core/templates/fullstack-architecture-tmpl.md +++ b/bmad-core/templates/fullstack-architecture-tmpl.md @@ -109,9 +109,9 @@ Document the choice and key services that will be used.]] Use appropriate diagram type for clarity.]] -````mermaid +```mermaid {{architecture_diagram}} -```text +``` ### Architectural Patterns @@ -222,7 +222,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]] model_interface; } } -```` +``` **Relationships:** @@ -246,7 +246,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]] **TypeScript Interface:** -````typescript +```typescript interface User { id: string; email: string; @@ -300,16 +300,16 @@ servers: '[object Object]': null description: '[object Object]': null -```` +``` ^^/CONDITION: has_rest_api^^ ^^CONDITION: has_graphql_api^^ -````graphql +```graphql # GraphQL Schema {{graphql_schema}} -```text +``` ^^/CONDITION: has_graphql_api^^ @@ -322,7 +322,7 @@ servers: trpc_routers; } } -```` +``` ^^/CONDITION: has_trpc_api^^ @@ -467,19 +467,19 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] **Component Organization:** -`````text -{{component_structure}} ```text +{{component_structure}} +``` **Component Template:** -````typescript +```typescript { { component_template; } } -```text +``` ### State Management Architecture @@ -493,7 +493,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] state_structure; } } -````` +``` **State Management Patterns:** @@ -512,13 +512,13 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] **Protected Route Pattern:** -````typescript +```typescript { { protected_route_example; } } -```text +``` ### Frontend Services Layer @@ -532,17 +532,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] api_client_setup; } } -```` +``` **Service Example:** -````typescript +```typescript { { service_example; } } -```text +``` ## Backend Architecture @@ -557,11 +557,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ^^CONDITION: serverless^^ **Function Organization:** -```` +```text {{function_structure}} -````text +``` **Function Template:** @@ -571,26 +571,26 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] function_template; } } -```` +``` ^^/CONDITION: serverless^^ ^^CONDITION: traditional_server^^ **Controller/Route Organization:** -`````text -{{controller_structure}} ```text +{{controller_structure}} +``` **Controller Template:** -````typescript +```typescript { { controller_template; } } -```text +``` ^^/CONDITION: traditional_server^^ @@ -602,17 +602,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ```sql {{database_schema}} -````` +``` **Data Access Layer:** -````typescript +```typescript { { repository_pattern; } } -```text +``` ### Authentication and Authorization @@ -622,17 +622,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ```mermaid {{auth_flow_diagram}} -```` +``` **Middleware/Guards:** -````typescript +```typescript { { auth_middleware; } } -```text +``` ## Unified Project Structure @@ -692,7 +692,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ├── package.json # Root package.json ├── {{monorepo_config}} # Monorepo configuration └── README.md -```` +``` @{example: vercel_structure} apps/ @@ -714,19 +714,19 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] **Prerequisites:** -````bash +```bash {{prerequisites_commands}} -```text +``` **Initial Setup:** ```bash {{setup_commands}} -```` +``` **Development Commands:** -````bash +```bash # Start all services {{start_all_command}} @@ -738,7 +738,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] # Run tests {{test_commands}} -```text +``` ### Environment Configuration @@ -753,7 +753,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] # Shared {{shared_env_vars}} -```` +``` ## Deployment Architecture @@ -776,9 +776,9 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ### CI/CD Pipeline -````yaml +```yaml '[object Object]': null -```text +``` ### Environments @@ -836,7 +836,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ### Testing Pyramid -```` +```text E2E Tests / \ @@ -845,17 +845,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] / \ Frontend Unit Backend Unit -```text +``` ### Test Organization **Frontend Tests:** -``` +```text {{frontend_test_structure}} -````text +``` **Backend Tests:** @@ -863,15 +863,15 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] {{backend_test_structure}} -```text +``` **E2E Tests:** -```` +```text {{e2e_test_structure}} -````text +``` ### Test Examples @@ -883,17 +883,17 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] frontend_test_example; } } -```` +``` **Backend API Test:** -````typescript +```typescript { { backend_test_example; } } -```text +``` **E2E Test:** @@ -903,7 +903,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] e2e_test_example; } } -```` +``` ## Coding Standards @@ -944,9 +944,9 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]] ### Error Flow -````mermaid +```mermaid {{error_flow_diagram}} -```text +``` ### Error Response Format @@ -960,17 +960,17 @@ interface ApiError { requestId: string; }; } -```` +``` ### Frontend Error Handling -````typescript +```typescript { { frontend_error_handler; } } -```text +``` ### Backend Error Handling @@ -980,7 +980,7 @@ interface ApiError { backend_error_handler; } } -```` +``` ## Monitoring and Observability diff --git a/bmad-core/templates/simple-project-prd-tmpl.md b/bmad-core/templates/simple-project-prd-tmpl.md index 044f687e..ffbcfb80 100644 --- a/bmad-core/templates/simple-project-prd-tmpl.md +++ b/bmad-core/templates/simple-project-prd-tmpl.md @@ -137,13 +137,13 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]] **TypeScript Interface:** -````typescript +```typescript { { model_interface; } } -```text +``` **Relationships:** @@ -183,7 +183,7 @@ interface UserProfile { bio?: string; preferences: Record; } -```` +``` **Relationships:** @@ -207,7 +207,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site), ^^CONDITION: has_rest_api^^ -````yml +```yml openapi: 3.0.0 info: title: @@ -221,7 +221,7 @@ servers: '[object Object]': null description: '[object Object]': null -```text +``` ^^/CONDITION: has_rest_api^^ @@ -230,7 +230,7 @@ servers: ```graphql # GraphQL Schema {{graphql_schema}} -```` +``` ^^/CONDITION: has_graphql_api^^ diff --git a/docs/versioning-and-releases.md b/docs/versioning-and-releases.md index 80157e57..a99ebefc 100644 --- a/docs/versioning-and-releases.md +++ b/docs/versioning-and-releases.md @@ -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: -````bash +```bash 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!: redesign CLI interface # → major release (4.1.0 → 5.0.0) -```text +``` ### What Happens Automatically @@ -35,24 +35,24 @@ git push # That's it! Release happens automatically 🎉 # Users can now run: npx bmad-method (and get the new version) -```` +``` ### Commits That DON'T Trigger Releases These commit types won't create releases (use them for maintenance): -````bash +```bash chore: update dependencies # No release docs: fix typo in readme # No release style: format code # No release test: add unit tests # No release -```text +``` ### Test Your Setup ```bash npm run release:test # Safe to run locally - tests the config -```` +``` --- diff --git a/expansion-packs/expansion-creator/tasks/generate-expansion-pack.md b/expansion-packs/expansion-creator/tasks/generate-expansion-pack.md index 73b7183f..053eda54 100644 --- a/expansion-packs/expansion-creator/tasks/generate-expansion-pack.md +++ b/expansion-packs/expansion-creator/tasks/generate-expansion-pack.md @@ -149,7 +149,7 @@ Create `expansion-packs/{pack-name}/plan.md` with: ## Approval User approval received: [ ] Yes -```text +``` Important: Wait for user approval before proceeding to Phase 2 @@ -282,34 +282,36 @@ IMPORTANT: Only proceed after plan.md is approved #### 3.1 Create Directory Structure ``` + expansion-packs/ └── {pack-name}/ - ├── plan.md (ALREADY CREATED) - ├── manifest.yml - ├── README.md - ├── agents/ - │ ├── {pack-name}-orchestrator.md (REQUIRED - Custom themed orchestrator) - │ └── {agent-id}.md (YAML-in-Markdown with persona) - ├── data/ - │ ├── {domain}-best-practices.md - │ ├── {domain}-terminology.md - │ └── {domain}-standards.md - ├── tasks/ - │ ├── create-doc.md (REQUIRED - Core utility) - │ ├── execute-checklist.md (REQUIRED - Core utility) - │ └── {task-name}.md (Domain-specific tasks) - ├── utils/ - │ ├── template-format.md (REQUIRED - Core utility) - │ └── workflow-management.md (REQUIRED - Core utility) - ├── templates/ - │ └── {template-name}.md - ├── checklists/ - │ └── {checklist-name}.md - ├── workflows/ - │ └── {domain}-workflow.md (REQUIRED if multiple agents) - └── agent-teams/ - └── {domain}-team.yml (REQUIRED if multiple agents) -```text +├── plan.md (ALREADY CREATED) +├── manifest.yml +├── README.md +├── agents/ +│ ├── {pack-name}-orchestrator.md (REQUIRED - Custom themed orchestrator) +│ └── {agent-id}.md (YAML-in-Markdown with persona) +├── data/ +│ ├── {domain}-best-practices.md +│ ├── {domain}-terminology.md +│ └── {domain}-standards.md +├── tasks/ +│ ├── create-doc.md (REQUIRED - Core utility) +│ ├── execute-checklist.md (REQUIRED - Core utility) +│ └── {task-name}.md (Domain-specific tasks) +├── utils/ +│ ├── template-format.md (REQUIRED - Core utility) +│ └── workflow-management.md (REQUIRED - Core utility) +├── templates/ +│ └── {template-name}.md +├── checklists/ +│ └── {checklist-name}.md +├── workflows/ +│ └── {domain}-workflow.md (REQUIRED if multiple agents) +└── agent-teams/ +└── {domain}-team.yml (REQUIRED if multiple agents) + +``` #### 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 cp bmad-core/utils/template-format.md expansion-packs/{pack-name}/utils/ cp bmad-core/utils/workflow-management.md expansion-packs/{pack-name}/utils/ -```text +``` **Step 3: Technical Implementation** @@ -695,10 +697,10 @@ _{Professional background and expertise}_ - `{file2}.{ext}` - {description} 2. **Launch Orchestrator**: + ```bash npm run agent {pack-name}-orchestrator ``` -```` 3. **Follow Numbered Options**: {Character Name} will present numbered choices for each decision @@ -728,14 +730,12 @@ _{Professional background and expertise}_ ### Knowledge Base [Embedded domain expertise] - ```` #### 6.3 Advanced Data File Documentation with Validation For each required data file, provide comprehensive guidance: -```markdown ## Required User Data Files ### {filename}.{ext} @@ -745,7 +745,6 @@ For each required data file, provide comprehensive guidance: - **Location**: Place in `bmad-core/data/` - **Validation**: {how agents will verify the file is correct} - **Example Structure**: -```` {sample content showing exact format} @@ -1021,3 +1020,11 @@ Embedded knowledge (automatic): - [ ] Template conditional content tested with different scenarios - [ ] Workflow decision trees validated with sample use cases - [ ] Character interactions tested for consistency and professional authenticity + +``` + +``` + +``` + +```