Skip to content

Commit 355df6d

Browse files
Brian MadisonBrian Madison
authored andcommitted
Add Astro + Starlight documentation site
- Set up website/ with Astro, Starlight, and custom styling - Add tools/build-docs.mjs for LLM-friendly doc generation - Add docs:build, docs:dev, docs:preview npm scripts - Configure GitHub Pages deployment via workflow - Add CNAME for bmad-builder-docs.bmad-method.org - Update README with documentation link
1 parent 9951736 commit 355df6d

21 files changed

Lines changed: 1487 additions & 5 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ on:
66
- main
77
paths:
88
- "docs/**"
9-
- "src/modules/*/docs/**"
109
- "website/**"
11-
- "tools/build-docs.js"
10+
- "tools/build-docs.mjs"
1211
- ".github/workflows/docs.yaml"
1312
workflow_dispatch:
1413

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
bmad-builder-docs.bmad-method.org

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,10 @@ See [bmad-module-template](https://github.com/bmad-code-org/bmad-module-template
8383

8484
## Documentation
8585

86-
- [BMad Method Docs](http://docs.bmad-method.org)
87-
- [Module Development Guide](http://docs.bmad-method.org/how-to/module-development/)
86+
**[BMad Builder Documentation](http://bmad-builder-docs.bmad-method.org)** — Tutorials, how-to guides, and reference
87+
88+
- [Getting Started](http://bmad-builder-docs.bmad-method.org/tutorials/)
89+
- [BMad Method Docs](http://docs.bmad-method.org) — Core framework documentation
8890

8991
## Community
9092

docs/how-to/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: How-To Guides
3+
description: Practical guides for specific BMad Builder tasks
4+
---
5+
6+
# How-To Guides
7+
8+
Step-by-step guides for completing specific tasks with BMad Builder.

docs/index.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
# BMad Builder Docs Index
1+
---
2+
title: Welcome
3+
description: BMad Builder - Tool for creating custom BMad agents and modules
4+
template: splash
5+
hero:
6+
title: BMad Builder
7+
subtitle: Tool for creating custom BMad agents and modules
8+
tagline: Create specialized AI agents with unique personalities, commands, and persistent memory.
9+
actions:
10+
- text: Get Started
11+
link: /tutorials/
12+
variant: primary
13+
- text: View on GitHub
14+
link: https://github.com/bmad-code-org/bmad-builder
15+
variant: minimal
16+
---
17+
18+
## Quick Start
19+
20+
[**Tutorials**](/tutorials/) - Step-by-step guides to create your first agent.
21+
22+
[**How-To Guides**](/how-to/) - Practical guides for specific tasks.
23+
24+
[**Explanation**](/explanation/) - Learn how BMad Builder works under the hood.
25+
26+
[**Reference**](/reference/) - Technical reference for configuration and options.

docs/reference/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Reference
3+
description: Technical reference for BMad Builder
4+
---
5+
6+
# Reference
7+
8+
Technical documentation for BMad Builder configuration and options.

docs/tutorials/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Tutorials
3+
description: Step-by-step tutorials for BMad Builder
4+
---
5+
6+
# Tutorials
7+
8+
Learn BMad Builder through step-by-step tutorials.

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"$schema": "https://json.schemastore.org/package.json",
33
"name": "bmad-builder",
4+
"type": "module",
45
"version": "0.1.5",
56
"description": "A BMad Core expansion module that guides users through the creation of Modules Workflow and Agents",
67
"keywords": [
@@ -15,6 +16,9 @@
1516
"main": "",
1617
"bin": {},
1718
"scripts": {
19+
"docs:build": "node tools/build-docs.mjs",
20+
"docs:dev": "astro dev --root website",
21+
"docs:preview": "astro preview --root website",
1822
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
1923
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
2024
"lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",

0 commit comments

Comments
 (0)