diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 2262ed7dd..fa136be49 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -27,6 +27,9 @@ jobs: steps: - name: Checkout repository uses: actions/checkout@v4 + with: + # Full history needed for Starlight's lastUpdated timestamps (git log) + fetch-depth: 0 - name: Setup Node.js uses: actions/setup-node@v4 diff --git a/docs/how-to/customize-bmad.md b/docs/how-to/customize-bmad.md index 6b6016671..9ebb7884f 100644 --- a/docs/how-to/customize-bmad.md +++ b/docs/how-to/customize-bmad.md @@ -140,7 +140,7 @@ The installer detects the existing installation and offers these options: | --------------------- | ------------------------------------------------------------------- | | **Quick Update** | Updates all modules to the latest version and recompiles all agents | | **Recompile Agents** | Applies customizations only, without updating module files | -| **Modify BMAD Installation** | Full installation flow for adding or removing modules | +| **Modify BMad Installation** | Full installation flow for adding or removing modules | For customization-only changes, **Recompile Agents** is the fastest option. diff --git a/docs/how-to/established-projects.md b/docs/how-to/established-projects.md index ef9acf704..5f1066a51 100644 --- a/docs/how-to/established-projects.md +++ b/docs/how-to/established-projects.md @@ -46,8 +46,8 @@ You have two primary options depending on the scope of changes: | Scope | Recommended Approach | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | -| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad method is likely overkill. | -| **Major changes or additions** | Start with the BMad method, applying as much or as little rigor as needed. | +| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad Method is likely overkill. | +| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. | ### During PRD Creation diff --git a/docs/how-to/shard-large-documents.md b/docs/how-to/shard-large-documents.md index 67a97a3ff..e58e37946 100644 --- a/docs/how-to/shard-large-documents.md +++ b/docs/how-to/shard-large-documents.md @@ -7,11 +7,13 @@ sidebar: Use the `shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management. -This is no longer recommended, and soon with updated workflows and most major llms and tools supporting sub processes this will be unnecessary. +:::caution[Deprecated] +This is no longer recommended, and soon with updated workflows and most major LLMs and tools supporting subprocesses this will be unnecessary. +::: ## When to Use This -Only use this if you notice your chosen tool / model combination are failing to load and read all the documents as input when needed. +Only use this if you notice your chosen tool / model combination is failing to load and read all the documents as input when needed. ## What is Document Sharding? diff --git a/docs/how-to/upgrade-to-v6.md b/docs/how-to/upgrade-to-v6.md index c631db84e..882640a69 100644 --- a/docs/how-to/upgrade-to-v6.md +++ b/docs/how-to/upgrade-to-v6.md @@ -31,7 +31,7 @@ When v4 is detected, you can: - Allow the installer to back up and remove `.bmad-method` - Exit and handle cleanup manually -If you named your bmad method folder something else - you will need to manual remove the folder yourself. +If you named your bmad method folder something else - you will need to manually remove the folder yourself. ### 3. Clean Up IDE Commands @@ -67,14 +67,14 @@ If you have stories created or implemented: ```text your-project/ -└── _bmad/ # Single installation folder - ├── _config/ # Your customizations - │ └── agents/ # Agent customization files - ├── core/ # Universal core framework - ├── bmm/ # BMad Method module - ├── bmb/ # BMad Builder - └── cis/ # Creative Intelligence Suite -├── _bmad-output/ # Output folder (was doc folder in v4) +├── _bmad/ # Single installation folder +│ ├── _config/ # Your customizations +│ │ └── agents/ # Agent customization files +│ ├── core/ # Universal core framework +│ ├── bmm/ # BMad Method module +│ ├── bmb/ # BMad Builder +│ └── cis/ # Creative Intelligence Suite +└── _bmad-output/ # Output folder (was doc folder in v4) ``` ## Module Migration diff --git a/docs/reference/agents.md b/docs/reference/agents.md index f82eb82f7..779f0b96e 100644 --- a/docs/reference/agents.md +++ b/docs/reference/agents.md @@ -5,9 +5,12 @@ sidebar: order: 2 --- +## Default Agents + This page lists the default BMM (Agile suite) agents that install with BMad Method, along with their menu triggers and primary workflows. -Notes: +## Notes + - Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu. - Slash commands are generated separately. See [Commands](./commands.md) for the slash command list and where they are defined. - QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module. diff --git a/docs/reference/workflow-map.md b/docs/reference/workflow-map.md index 1557a905b..fc38b69ee 100644 --- a/docs/reference/workflow-map.md +++ b/docs/reference/workflow-map.md @@ -25,7 +25,7 @@ Explore the problem space and validate ideas before committing to planning. | Workflow | Purpose | Produces | | ---------------------- | -------------------------------------------------------------------------- | ------------------------- | -| `brainstorm` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` | +| `brainstorming` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` | | `research` | Validate market, technical, or domain assumptions | Research findings | | `create-product-brief` | Capture strategic vision | `product-brief.md` | diff --git a/website/src/styles/custom.css b/website/src/styles/custom.css index b07ff4986..a8f66a2fd 100644 --- a/website/src/styles/custom.css +++ b/website/src/styles/custom.css @@ -479,16 +479,10 @@ blockquote { } /* ============================================ - FOOTER - Minimal styling + FOOTER - No custom styling needed + The only