remaining bad character removal
This commit is contained in:
parent
74f54a088a
commit
8f7d259c81
|
|
@ -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 @@
|
|||
<critical>IMPORTANT: Create install-config.yaml NOT install-config.yaml</critical>
|
||||
<critical>This is the STANDARD format that BMAD installer uses</critical>
|
||||
|
||||
Create \_module-installer/install-config.yaml:
|
||||
Create module-installer/install-config.yaml:
|
||||
|
||||
```yaml
|
||||
# {{module_name}} Module Configuration
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
|
|
@ -64,5 +64,5 @@ src/modules/cis/sub-modules/
|
|||
src/modules/bmgd/sub-modules/
|
||||
|
||||
# Test Install Output
|
||||
|
||||
z-samples
|
||||
z*/.claude/settings.local.json
|
||||
|
|
|
|||
|
|
@ -271,13 +271,13 @@ 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 |
|
||||
| module-installer copied | Fixed: Now excluded from copy |
|
||||
|
||||
### Debug Commands
|
||||
|
||||
|
|
|
|||
|
|
@ -136,7 +136,7 @@ For each story in epic {{N}}, output variables following this pattern:
|
|||
<template-output>epic*goal*{{N}}</template-output>
|
||||
|
||||
<action>For each story M in epic {{N}}, generate story content</action>
|
||||
<template-output>story-title-{{N}}\_{{M}}</template-output>
|
||||
<template-output>story-title-{{N}}-{{M}}</template-output>
|
||||
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -382,7 +382,7 @@ Alice (Product Owner): "Good thinking - helps us connect what we learned to what
|
|||
<action>Attempt to load next epic using selective loading strategy:</action>
|
||||
|
||||
**Try sharded first (more specific):**
|
||||
<action>Check if file exists: {output-folder}/\_epic\*/epic-{{next_epic_num}}.md</action>
|
||||
<action>Check if file exists: {output-folder}/epic\*/epic-{{next_epic_num}}.md</action>
|
||||
|
||||
<check if="sharded epic file found">
|
||||
<action>Load {output_folder}/*epic*/epic-{{next_epic_num}}.md</action>
|
||||
|
|
@ -391,7 +391,7 @@ Alice (Product Owner): "Good thinking - helps us connect what we learned to what
|
|||
|
||||
**Fallback to whole document:**
|
||||
<check if="sharded epic not found">
|
||||
<action>Check if file exists: {output-folder}/\_epic\*.md</action>
|
||||
<action>Check if file exists: {output-folder}/epic\*.md</action>
|
||||
|
||||
<check if="whole epic file found">
|
||||
<action>Load entire epics document</action>
|
||||
|
|
|
|||
|
|
@ -137,9 +137,9 @@ This will read EVERY file in this area. Proceed? [y/n]
|
|||
<action>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
|
||||
</action>
|
||||
|
||||
<template-output>comprehensive_file_inventory</template-output>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
}
|
||||
</action>
|
||||
|
|
|
|||
|
|
@ -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:**
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue