docs: post install notes (#1653)
This commit is contained in:
parent
3103c3d4ce
commit
ae7b3a7930
|
|
@ -5,3 +5,56 @@
|
|||
For external official modules to be discoverable during install, ensure an entry for the external repo is added to external-official-modules.yaml.
|
||||
|
||||
For community modules - this will be handled in a different way. This file is only for registration of modules under the bmad-code-org.
|
||||
|
||||
## Post-Install Notes
|
||||
|
||||
Modules can display setup guidance to users after configuration is collected during `npx bmad-method install`. Notes are defined in the module's own `module.yaml` — no changes to the installer are needed.
|
||||
|
||||
### Simple Format
|
||||
|
||||
Always displayed after the module is configured:
|
||||
|
||||
```yaml
|
||||
post-install-notes: |
|
||||
Remember to set the API_KEY environment variable.
|
||||
See: https://example.com/setup
|
||||
```
|
||||
|
||||
### Conditional Format
|
||||
|
||||
Display different messages based on a config question's answer:
|
||||
|
||||
```yaml
|
||||
post-install-notes:
|
||||
config_key_name:
|
||||
value1: |
|
||||
Instructions for value1...
|
||||
value2: |
|
||||
Instructions for value2...
|
||||
```
|
||||
|
||||
Values without an entry (e.g., `none`) display nothing. Multiple config keys can each have their own conditional notes.
|
||||
|
||||
### Example: TEA Module
|
||||
|
||||
The TEA module uses the conditional format keyed on `tea_browser_automation`:
|
||||
|
||||
```yaml
|
||||
post-install-notes:
|
||||
tea_browser_automation:
|
||||
cli: |
|
||||
Playwright CLI Setup:
|
||||
npm install -g @playwright/cli@latest
|
||||
playwright-cli install --skills
|
||||
mcp: |
|
||||
Playwright MCP Setup (two servers):
|
||||
1. playwright — npx @playwright/mcp@latest
|
||||
2. playwright-test — npx playwright run-test-mcp-server
|
||||
auto: |
|
||||
Playwright CLI Setup:
|
||||
...
|
||||
Playwright MCP Setup (two servers):
|
||||
...
|
||||
```
|
||||
|
||||
When a user selects `auto`, they see both CLI and MCP instructions. When they select `none`, nothing is shown.
|
||||
|
|
|
|||
Loading…
Reference in New Issue