diff --git a/.bmad/bmb/workflows/create-module/instructions.md b/.bmad/bmb/workflows/create-module/instructions.md index 97d6a142..494a2ff3 100644 --- a/.bmad/bmb/workflows/create-module/instructions.md +++ b/.bmad/bmb/workflows/create-module/instructions.md @@ -180,7 +180,7 @@ └── data/ # User data directory ``` -**SOURCE MODULE** (\_module-installer is for installation only, not copied to target): +**SOURCE MODULE** (module-installer is for installation only, not copied to target): ``` {{module_code}}/ @@ -268,7 +268,7 @@ IMPORTANT: Create install-config.yaml NOT install-config.yaml This is the STANDARD format that BMAD installer uses -Create \_module-installer/install-config.yaml: +Create module-installer/install-config.yaml: ```yaml # {{module_name}} Module Configuration diff --git a/.bmad/bmb/workflows/create-module/module-structure.md b/.bmad/bmb/workflows/create-module/module-structure.md index 6f09ce59..5a471f44 100644 --- a/.bmad/bmb/workflows/create-module/module-structure.md +++ b/.bmad/bmb/workflows/create-module/module-structure.md @@ -172,7 +172,7 @@ menu: ## Installation Infrastructure -### Required: \_module-installer/install-config.yaml +### Required: module-installer/install-config.yaml This file defines both installation questions AND static configuration values: @@ -226,7 +226,7 @@ data_path: - `result` field uses placeholders: `{value}`, `{project-root}`, `{directory_name}` - Installer generates final `config.yaml` from this template -### Optional: \_module-installer/installer.js +### Optional: module-installer/installer.js For complex installations requiring custom logic: @@ -252,7 +252,7 @@ async function install(options) { module.exports = { install }; ``` -### Optional: \_module-installer/assets/ +### Optional: module-installer/assets/ Files to copy during installation: diff --git a/.gitignore b/.gitignore index 7462d788..50e51c8f 100644 --- a/.gitignore +++ b/.gitignore @@ -64,5 +64,5 @@ src/modules/cis/sub-modules/ src/modules/bmgd/sub-modules/ # Test Install Output - +z-samples z*/.claude/settings.local.json diff --git a/docs/installers-bundlers/installers-modules-platforms-reference.md b/docs/installers-bundlers/installers-modules-platforms-reference.md index a0c7f074..4fa5eee2 100644 --- a/docs/installers-bundlers/installers-modules-platforms-reference.md +++ b/docs/installers-bundlers/installers-modules-platforms-reference.md @@ -270,14 +270,14 @@ Generated in: `bmad/_cfg/agents/{module}-{agent}.md` ### Common Issues -| Issue | Solution | -| ------------------------- | ----------------------------------- | -| Existing installation | Use `bmad update` or remove `bmad/` | -| Module not found | Check `src/modules/` exists | -| Config not applied | Verify `bmad/{module}/config.yaml` | -| Missing config.yaml | Fixed: All modules now get configs | -| Agent unavailable | Check for `localskip="true"` | -| \_module-installer copied | Fixed: Now excluded from copy | +| Issue | Solution | +| ----------------------- | ----------------------------------- | +| Existing installation | Use `bmad update` or remove `bmad/` | +| Module not found | Check `src/modules/` exists | +| Config not applied | Verify `bmad/{module}/config.yaml` | +| Missing config.yaml | Fixed: All modules now get configs | +| Agent unavailable | Check for `localskip="true"` | +| module-installer copied | Fixed: Now excluded from copy | ### Debug Commands diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md b/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md index ae9b7ddb..322a9947 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md @@ -136,7 +136,7 @@ For each story in epic {{N}}, output variables following this pattern: epic*goal*{{N}} For each story M in epic {{N}}, generate story content -story-title-{{N}}\_{{M}} +story-title-{{N}}-{{M}} {project-root}/{bmad_folder}/core/tasks/adv-elicit.xml diff --git a/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md b/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md index a71d50c4..879d34a7 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +++ b/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md @@ -201,7 +201,7 @@ Analyze the existing project structure: 4. **Testing Patterns & Standards (CRITICAL):** - Identify test framework in use (from package.json/requirements.txt) - - Note test file naming patterns (.test.js, \_test.py, .spec.ts, Test.java) + - Note test file naming patterns (.test.js, test.py, .spec.ts, Test.java) - Document test organization (tests/, **tests**, spec/, test/) - Look for test configuration files (jest.config.js, pytest.ini, .rspec) - Check for coverage requirements (in CI config, test scripts) diff --git a/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md b/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md index 81761233..70c2ff96 100644 --- a/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +++ b/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md @@ -382,7 +382,7 @@ Alice (Product Owner): "Good thinking - helps us connect what we learned to what Attempt to load next epic using selective loading strategy: **Try sharded first (more specific):** -Check if file exists: {output-folder}/\_epic\*/epic-{{next_epic_num}}.md +Check if file exists: {output-folder}/epic\*/epic-{{next_epic_num}}.md Load {output_folder}/*epic*/epic-{{next_epic_num}}.md @@ -391,7 +391,7 @@ Alice (Product Owner): "Good thinking - helps us connect what we learned to what **Fallback to whole document:** -Check if file exists: {output-folder}/\_epic\*.md +Check if file exists: {output-folder}/epic\*.md Load entire epics document diff --git a/src/modules/bmm/workflows/document-project/workflows/deep-dive-instructions.md b/src/modules/bmm/workflows/document-project/workflows/deep-dive-instructions.md index 57de41b4..621c843c 100644 --- a/src/modules/bmm/workflows/document-project/workflows/deep-dive-instructions.md +++ b/src/modules/bmm/workflows/document-project/workflows/deep-dive-instructions.md @@ -137,10 +137,10 @@ This will read EVERY file in this area. Proceed? [y/n] For each file in file\*inventory, document: - **File Path:** Full path - **Purpose:** What this file does (1-2 sentences) - **Lines of Code:** Total LOC - **Exports:** Complete list with signatures - Functions: `functionName(param: Type): ReturnType` - Description - _ Classes: `ClassName` - Description with key methods - _ Types/Interfaces: `TypeName` - Description - \_ Constants: `CONSTANT_NAME: Type` - Description - **Imports/Dependencies:** What it uses and why - **Used By:** Files that import this (dependents) - **Key Implementation Details:** Important logic, algorithms, patterns - **State Management:** If applicable (Redux, Context, local state) - **Side Effects:** API calls, database queries, file I/O, external services - **Error Handling:** Try/catch blocks, error boundaries, validation - **Testing:** Associated test files and coverage - **Comments/TODOs:** Any inline documentation or planned work - + - Classes: `ClassName` - Description with key methods + - Types/Interfaces: `TypeName` - Description + - Constants: `CONSTANT_NAME: Type` - Description - **Imports/Dependencies:** What it uses and why - **Used By:** Files that import this (dependents) - **Key Implementation Details:** Important logic, algorithms, patterns - **State Management:** If applicable (Redux, Context, local state) - **Side Effects:** API calls, database queries, file I/O, external services - **Error Handling:** Try/catch blocks, error boundaries, validation - **Testing:** Associated test files and coverage - **Comments/TODOs:** Any inline documentation or planned work + comprehensive_file_inventory diff --git a/src/modules/bmm/workflows/document-project/workflows/full-scan-instructions.md b/src/modules/bmm/workflows/document-project/workflows/full-scan-instructions.md index 5d26e964..3026e325 100644 --- a/src/modules/bmm/workflows/document-project/workflows/full-scan-instructions.md +++ b/src/modules/bmm/workflows/document-project/workflows/full-scan-instructions.md @@ -758,15 +758,15 @@ When a document SHOULD be generated but wasn't (due to quick scan, missing data, ### Generated Documentation - [Project Overview](./project-overview.md) -- [Architecture](./architecture{{#if multi-part}}-{part*id}{{/if}}.md){{#unless architecture_file_exists}} *(To be generated)\_{{/unless}} +- [Architecture](./architecture{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless architecture_file_exists}} (To be generated) {{/unless}} - [Source Tree Analysis](./source-tree-analysis.md) -- [Component Inventory](./component-inventory{{#if multi-part}}-{part*id}{{/if}}.md){{#unless component_inventory_exists}} *(To be generated)\_{{/unless}} -- [Development Guide](./development-guide{{#if multi-part}}-{part*id}{{/if}}.md){{#unless dev_guide_exists}} *(To be generated)_{{/unless}} - {{#if deployment_found}}- [Deployment Guide](./deployment-guide.md){{#unless deployment_guide_exists}} _(To be generated)_{{/unless}}{{/if}} +- [Component Inventory](./component-inventory{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless component_inventory_exists}} (To be generated) {{/unless}} +- [Development Guide](./development-guide{{#if multi-part}}-{part\*id}{{/if}}.md){{#unless dev_guide_exists}} (To be generated) {{/unless}} + {{#if deployment_found}}- [Deployment Guide](./deployment-guide.md){{#unless deployment_guide_exists}} (To be generated) {{/unless}}{{/if}} {{#if contribution_found}}- [Contribution Guide](./contribution-guide.md){{/if}} - {{#if api_documented}}- [API Contracts](./api-contracts{{#if multi-part}}-{part_id}{{/if}}.md){{#unless api_contracts_exists}} _(To be generated)_{{/unless}}{{/if}} - {{#if data_models_documented}}- [Data Models](./data-models{{#if multi-part}}-{part_id}{{/if}}.md){{#unless data_models_exists}} _(To be generated)_{{/unless}}{{/if}} - {{#if multi-part}}- [Integration Architecture](./integration-architecture.md){{#unless integration_arch_exists}} _(To be generated)\_{{/unless}}{{/if}} + {{#if api_documented}}- [API Contracts](./api-contracts{{#if multi-part}}-{part_id}{{/if}}.md){{#unless api_contracts_exists}} (To be generated) {{/unless}}{{/if}} + {{#if data_models_documented}}- [Data Models](./data-models{{#if multi-part}}-{part_id}{{/if}}.md){{#unless data_models_exists}} (To be generated) {{/unless}}{{/if}} + {{#if multi-part}}- [Integration Architecture](./integration-architecture.md){{#unless integration_arch_exists}} (To be generated) {{/unless}}{{/if}} ### Existing Documentation @@ -850,10 +850,10 @@ Set {{incomplete_docs_list}} = {{incomplete_docs_strict}} + {{incomplete_docs_fu For each item store structure: { "title": "Architecture – Server", -"file*path": "./architecture-server.md", +"file\*path": "./architecture-server.md", "doc_type": "architecture", "part_id": "server", -"line_text": "- [Architecture – Server](./architecture-server.md) *(To be generated)\_", +"line_text": "- [Architecture – Server](./architecture-server.md) (To be generated)", "fuzzy_match": false } diff --git a/src/modules/bmm/workflows/testarch/test-design/test-design-template.md b/src/modules/bmm/workflows/testarch/test-design/test-design-template.md index df21320f..0ed1c646 100644 --- a/src/modules/bmm/workflows/testarch/test-design/test-design-template.md +++ b/src/modules/bmm/workflows/testarch/test-design/test-design-template.md @@ -250,9 +250,9 @@ **Test Design Approved By:** -- [ ] Product Manager: **\*\***\_\_\_**\*\*** Date: **\*\***\_\_\_**\*\*** -- [ ] Tech Lead: **\*\***\_\_\_**\*\*** Date: **\*\***\_\_\_**\*\*** -- [ ] QA Lead: **\*\***\_\_\_**\*\*** Date: **\*\***\_\_\_**\*\*** +- [ ] Product Manager: {name} Date: {date} +- [ ] Tech Lead: {name} Date: {date} +- [ ] QA Lead: {name} Date: {date} **Comments:**