fix(docs): address documentation review findings

Fix broken directory tree, grammar errors, inconsistent naming,
missing admonition/headings, enable lastUpdated timestamps in CI,
and remove footer CSS that misapplied to the content footer.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Alex Verkhovsky 2026-02-08 01:43:09 -07:00
parent 6030c8f53f
commit 3b6f39d46d
8 changed files with 27 additions and 25 deletions

View File

@ -27,6 +27,9 @@ jobs:
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
with:
# Full history needed for Starlight's lastUpdated timestamps (git log)
fetch-depth: 0
- name: Setup Node.js - name: Setup Node.js
uses: actions/setup-node@v4 uses: actions/setup-node@v4

View File

@ -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 | | **Quick Update** | Updates all modules to the latest version and recompiles all agents |
| **Recompile Agents** | Applies customizations only, without updating module files | | **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. For customization-only changes, **Recompile Agents** is the fastest option.

View File

@ -46,8 +46,8 @@ You have two primary options depending on the scope of changes:
| Scope | Recommended Approach | | 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. | | **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. | | **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. |
### During PRD Creation ### During PRD Creation

View File

@ -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. 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 ## 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? ## What is Document Sharding?

View File

@ -31,7 +31,7 @@ When v4 is detected, you can:
- Allow the installer to back up and remove `.bmad-method` - Allow the installer to back up and remove `.bmad-method`
- Exit and handle cleanup manually - 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 ### 3. Clean Up IDE Commands
@ -67,14 +67,14 @@ If you have stories created or implemented:
```text ```text
your-project/ your-project/
── _bmad/ # Single installation folder ── _bmad/ # Single installation folder
├── _config/ # Your customizations ├── _config/ # Your customizations
│ └── agents/ # Agent customization files │ └── agents/ # Agent customization files
├── core/ # Universal core framework ├── core/ # Universal core framework
├── bmm/ # BMad Method module ├── bmm/ # BMad Method module
├── bmb/ # BMad Builder ├── bmb/ # BMad Builder
└── cis/ # Creative Intelligence Suite └── cis/ # Creative Intelligence Suite
── _bmad-output/ # Output folder (was doc folder in v4) ── _bmad-output/ # Output folder (was doc folder in v4)
``` ```
## Module Migration ## Module Migration

View File

@ -5,9 +5,12 @@ sidebar:
order: 2 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. 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. - 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. - 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. - QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module.

View File

@ -25,7 +25,7 @@ Explore the problem space and validate ideas before committing to planning.
| Workflow | Purpose | Produces | | 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 | | `research` | Validate market, technical, or domain assumptions | Research findings |
| `create-product-brief` | Capture strategic vision | `product-brief.md` | | `create-product-brief` | Capture strategic vision | `product-brief.md` |

View File

@ -479,16 +479,10 @@ blockquote {
} }
/* ============================================ /* ============================================
FOOTER - Minimal styling FOOTER - No custom styling needed
The only <footer> in Starlight is the content footer
(meta/pagination), which should stay transparent.
============================================ */ ============================================ */
footer {
background-color: var(--sl-color-black);
border-top: 1px solid var(--sl-color-hairline);
}
:root[data-theme='dark'] footer {
background-color: #020617;
}
/* ============================================ /* ============================================
RESPONSIVE ADJUSTMENTS RESPONSIVE ADJUSTMENTS