History

Brian db2270c7ea fix(deps): resolve Dependabot security alerts via astro 6 upgrade (#2493 ) Clears all 11 open Dependabot alerts on main: - astro 5.18.1 -> 6.4.6, @astrojs/starlight 0.37.5 -> 0.40.0, @astrojs/sitemap 3.6.0 -> 3.7.3 (8 XSS/SSRF advisories) - esbuild pinned to 0.28.1 via override (astro/vite cap at ^0.27; fixes dev-server arbitrary file read on Windows) - markdown-it -> 14.2.0 via override (smartquotes ReDoS) - brace-expansion (under glob) -> 5.0.6 (range DoS) Astro 6 migration for the docs site: - content config moved to src/content.config.ts with loaders - sidebar autogenerate groups wrapped in items[] (Starlight v0.39) - 404 page uses render(entry) instead of entry.render() Verified: docs:build produces an identical page set vs the pre-upgrade baseline; sidebar validation and format checks pass.		2026-06-21 16:52:15 -05:00
..
public	docs(fr): sync French docs with latest English source + fix non-ASCII anchor validation (#2408 )	2026-06-06 20:34:42 -05:00
src	fix(deps): resolve Dependabot security alerts via astro 6 upgrade (#2493 )	2026-06-21 16:52:15 -05:00
README.md	refactor: remove downloads page and bundle generation (#1577 )	2026-02-06 23:26:39 -06:00
astro.config.mjs	fix(deps): resolve Dependabot security alerts via astro 6 upgrade (#2493 )	2026-06-21 16:52:15 -05:00

README.md

BMAD Method Documentation Site

This directory contains the Astro + Starlight configuration for the BMAD Method documentation site.

Architecture

The documentation uses a symlink architecture to keep content in docs/ at the repo root while serving it through Astro:

bmad2/
├── docs/                          # Content lives here (repo root)
│   ├── index.md
│   ├── tutorials/
│   ├── how-to/
│   ├── explanation/
│   └── reference/
└── website/
    ├── astro.config.mjs           # Astro + Starlight config
    ├── src/
    │   ├── content/
    │   │   └── docs -> ../../docs # Symlink to content
    │   └── styles/
    │       └── custom.css         # Custom styling
    └── public/                    # Static assets

Development

# From repo root
npm run docs:dev      # Start dev server
npm run docs:build    # Build for production
npm run docs:preview  # Preview production build

Platform Notes

Windows Symlink Support

The website/src/content/docs symlink may not work correctly on Windows without Developer Mode enabled or administrator privileges.

To enable symlinks on Windows:

Enable Developer Mode (recommended):
- Settings → Update & Security → For developers → Developer Mode: On
- This allows creating symlinks without admin rights
Or use Git's symlink support:
```
git config core.symlinks true
```
Then re-clone the repository.

Or create a junction (alternative):

# Run as Administrator
mklink /J website\src\content\docs ..\..\docs

If symlinks don't work, you can copy the docs folder instead:

# Remove the symlink
rm website/src/content/docs

# Copy the docs folder
cp -r docs website/src/content/docs

Note: If copying, remember to keep the copy in sync with changes to docs/.

Build Output

The build pipeline (npm run docs:build) produces:

Static HTML site in build/site/
LLM-friendly files: llms.txt, llms-full.txt