diff --git a/ASSETS_NEEDED.md b/ASSETS_NEEDED.md new file mode 100644 index 00000000..7e35082c --- /dev/null +++ b/ASSETS_NEEDED.md @@ -0,0 +1,52 @@ +# 🎨 Visual Assets Needed + +The BMad Method documentation requires the following visual assets to complete the professional branding: + +## **Required Assets** + +### 1. **BMad Method Logo** (`bmad-logo.png`) +- **Purpose**: Main logo displayed in documentation header +- **Dimensions**: 200x50px (recommended) +- **Format**: PNG with transparent background +- **Style Guidelines**: + - Should represent the BMad Method brand + - Clean, professional appearance + - Works well on both light and dark backgrounds + - Readable at small sizes + +### 2. **Favicon** (`favicon.png`) +- **Purpose**: Browser tab icon for documentation site +- **Dimensions**: 32x32px (can also provide 16x16px) +- **Format**: PNG or ICO +- **Style Guidelines**: + - Simple, recognizable icon derived from main logo + - Clear at very small sizes + - Represents BMad Method identity + +## **Integration** + +Once assets are created: + +1. Place files in `docs/assets/images/` directory +2. Uncomment lines in `mkdocs.yml`: + ```yaml + logo: assets/images/bmad-logo.png + favicon: assets/images/favicon.png + ``` +3. Test with `mkdocs serve` to verify proper display + +## **Design Notes** + +- **Brand Colors**: Consider using blues (#1976d2) to match current theme +- **Typography**: Should complement Material Design theme +- **Simplicity**: Keep designs clean and minimal for best documentation experience + +## **Priority** + +**High** - Visual branding significantly improves documentation professionalism and user experience. + +--- + +**Status**: 🔴 **PENDING** - Assets not yet created +**Owner**: Design team or contractor +**Estimated Time**: 2-4 hours for both assets \ No newline at end of file diff --git a/README.md b/README.md index d6e39473..7af13718 100644 --- a/README.md +++ b/README.md @@ -150,12 +150,14 @@ bmad-agent/ ## Memory System Integration -BMAD integrates with OpenMemory MCP for persistent intelligence: +BMAD integrates with [OpenMemory MCP](https://mem0.ai/openmemory-mcp) for persistent intelligence: - **Automated Learning**: Captures decisions, patterns, and outcomes - **Search & Retrieval**: Finds relevant past experiences - **Pattern Recognition**: Identifies successful approaches - **Continuous Improvement**: Gets smarter with each use +**Setup**: Follow the [OpenMemory MCP Setup Guide](./docs/setup-configuration/openmemory-setup.md) to enable advanced memory features. + ## Quality Metrics The framework tracks comprehensive quality metrics: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 9b659c3b..a895ed02 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -32,7 +32,7 @@ By participating in this project, you agree to abide by our Code of Conduct. Ple ## Commit Message Convention -[Commit Convention](./docs/commit.md) +[Commit Convention](commit.md) ## Code Style diff --git a/docs/assets/images/.gitkeep b/docs/assets/images/.gitkeep new file mode 100644 index 00000000..f2f69ff8 --- /dev/null +++ b/docs/assets/images/.gitkeep @@ -0,0 +1,16 @@ +# Assets Directory + +This directory contains visual assets for the BMad Method documentation. + +## Missing Assets (Need to be added): +- bmad-logo.png: Main logo for the documentation site +- favicon.png: Browser tab icon for the documentation site + +## Recommended Sizes: +- Logo: 200x50px (PNG with transparent background) +- Favicon: 32x32px (PNG or ICO format) + +## Usage: +These assets are referenced in mkdocs.yml: +- logo: assets/images/bmad-logo.png +- favicon: assets/images/favicon.png \ No newline at end of file diff --git a/docs/assets/images/ASSETS_NEEDED.md b/docs/assets/images/ASSETS_NEEDED.md new file mode 100644 index 00000000..7e35082c --- /dev/null +++ b/docs/assets/images/ASSETS_NEEDED.md @@ -0,0 +1,52 @@ +# 🎨 Visual Assets Needed + +The BMad Method documentation requires the following visual assets to complete the professional branding: + +## **Required Assets** + +### 1. **BMad Method Logo** (`bmad-logo.png`) +- **Purpose**: Main logo displayed in documentation header +- **Dimensions**: 200x50px (recommended) +- **Format**: PNG with transparent background +- **Style Guidelines**: + - Should represent the BMad Method brand + - Clean, professional appearance + - Works well on both light and dark backgrounds + - Readable at small sizes + +### 2. **Favicon** (`favicon.png`) +- **Purpose**: Browser tab icon for documentation site +- **Dimensions**: 32x32px (can also provide 16x16px) +- **Format**: PNG or ICO +- **Style Guidelines**: + - Simple, recognizable icon derived from main logo + - Clear at very small sizes + - Represents BMad Method identity + +## **Integration** + +Once assets are created: + +1. Place files in `docs/assets/images/` directory +2. Uncomment lines in `mkdocs.yml`: + ```yaml + logo: assets/images/bmad-logo.png + favicon: assets/images/favicon.png + ``` +3. Test with `mkdocs serve` to verify proper display + +## **Design Notes** + +- **Brand Colors**: Consider using blues (#1976d2) to match current theme +- **Typography**: Should complement Material Design theme +- **Simplicity**: Keep designs clean and minimal for best documentation experience + +## **Priority** + +**High** - Visual branding significantly improves documentation professionalism and user experience. + +--- + +**Status**: 🔴 **PENDING** - Assets not yet created +**Owner**: Design team or contractor +**Estimated Time**: 2-4 hours for both assets \ No newline at end of file diff --git a/docs/commands/quick-reference.md b/docs/commands/quick-reference.md index e065818a..392c99de 100644 --- a/docs/commands/quick-reference.md +++ b/docs/commands/quick-reference.md @@ -13,7 +13,7 @@ Complete reference for all BMad Method commands with contextual usage guidance a |---------|-------------|-------------|---------| | `/help` | Show available commands and context-aware suggestions | When starting a session or unsure about next steps | `/help` | | `/agents` | List all available personas with descriptions | When choosing which persona to activate | `/agents` | -| `/context` | Display current session context and memory insights | Before switching personas or when resuming work | `/context` | +| `/context` 🧠 | Display current session context and memory insights | Before switching personas or when resuming work | `/context` | | `/yolo` | Toggle YOLO mode for comprehensive execution | When you want full automation vs step-by-step control | `/yolo` | | `/core-dump` | Execute enhanced core-dump with memory integration | When debugging issues or need complete system status | `/core-dump` | | `/exit` | Abandon current agent with memory preservation | When finished with current persona or switching contexts | `/exit` | @@ -28,20 +28,23 @@ Complete reference for all BMad Method commands with contextual usage guidance a | `/po` | Switch to Product Owner (Sam) | Backlog management, user stories | Sprint planning, story refinement | | `/sm` | Switch to Scrum Master (Taylor) | Process improvement, team facilitation | Throughout project, retrospectives | | `/analyst` | Switch to Business Analyst (Jordan) | Research, analysis, requirements gathering | Project initiation, discovery phases | -| `/design` | Switch to Design Architect (Casey) | UI/UX design, user experience | After requirements, parallel with architecture | +| `/design-architect` | Switch to Design Architect (Casey) | UI/UX design, user experience | After requirements, parallel with architecture | | `/quality` | Switch to Quality Enforcer (Riley) | Quality assurance, standards enforcement | Throughout development, reviews | ### Memory-Enhanced Commands +!!! note "OpenMemory MCP Integration" + Commands marked with 🧠 require [OpenMemory MCP](../setup-configuration/openmemory-setup.md) for full functionality. Without OpenMemory, these commands fall back to session-based memory. + | Command | Description | Usage Context | Impact | |---------|-------------|---------------|--------| -| `/remember {content}` | Manually add important information to memory | After making key decisions or discoveries | Improves future recommendations | -| `/recall {query}` | Search memories with natural language queries | When you need to remember past decisions or patterns | Provides historical context | +| `/remember {content}` 🧠 | Manually add important information to memory | After making key decisions or discoveries | Improves future recommendations | +| `/recall {query}` 🧠 | Search memories with natural language queries | When you need to remember past decisions or patterns | Provides historical context | | `/udtm` | Execute Ultra-Deep Thinking Mode | For major decisions requiring comprehensive analysis | Provides systematic analysis | | `/anti-pattern-check` | Scan for anti-patterns | During development and review phases | Identifies problematic code patterns | | `/suggest` | AI-powered next step recommendations | When stuck or want validation of next steps | Provides contextual guidance | -| `/handoff {persona}` | Structured persona transition with memory briefing | When switching personas mid-task | Ensures continuity | -| `/bootstrap-memory` | Initialize memory for brownfield projects | When starting work on existing projects | Builds historical context | +| `/handoff {persona}` 🧠 | Structured persona transition with memory briefing | When switching personas mid-task | Ensures continuity | +| `/bootstrap-memory` 🧠 | Initialize memory for brownfield projects | When starting work on existing projects | Builds historical context | | `/quality-gate {phase}` | Run quality gate validation | At key project milestones | Ensures quality standards | | `/brotherhood-review` | Initiate peer validation process | Before major decisions or deliverables | Enables collaborative validation | | `/checklist {name}` | Run validation checklist | To ensure completeness and quality | Systematic validation | diff --git a/docs/commit.md b/docs/commit.md new file mode 100644 index 00000000..1bbb45e3 --- /dev/null +++ b/docs/commit.md @@ -0,0 +1,83 @@ +# Commit Message Convention + +We follow a structured commit message format to maintain clarity and consistency across the project. + +## Format + +``` +(): + + + +