Skip to content

Commit 2897c80

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 game-dev-studio-docs.bmad-method.org - Update README with documentation link - Restructure docs into Diataxis format (tutorials, how-to, explanation, reference)
1 parent ef9ddc8 commit 2897c80

26 files changed

Lines changed: 1556 additions & 76 deletions

.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+
game-dev-studio-docs.bmad-method.org

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,10 @@ BMGD: Great choice! Here's what I recommend...
9696

9797
## Documentation
9898

99-
- [BMad Method Docs](http://docs.bmad-method.org)
100-
- [BMGD Guide](http://docs.bmad-method.org/bmgd/)
99+
**[BMad Game Dev Studio Documentation](http://game-dev-studio-docs.bmad-method.org)** — Tutorials, how-to guides, and reference
100+
101+
- [Getting Started](http://game-dev-studio-docs.bmad-method.org/tutorials/)
102+
- [BMad Method Docs](http://docs.bmad-method.org) — Core framework documentation
101103

102104
## Community
103105

File renamed without changes.
File renamed without changes.

docs/explanation/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Explanation
3+
description: Learn how BMGD works
4+
---
5+
6+
# Explanation
7+
8+
Learn how BMad Game Dev Studio works under the hood.
9+
10+
- **[Game Types](game-types.md)** - Selecting and using game type templates
11+
- **[BMGD vs BMM](bmgd-vs-bmm.md)** - Understanding the differences

docs/game-dev/index.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

docs/how-to/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: How-To Guides
3+
description: Practical guides for game development tasks
4+
---
5+
6+
# How-To Guides
7+
8+
Step-by-step guides for completing specific game development tasks.
9+
10+
## Quick Guides
11+
12+
- **[Coming Soon]** - Quick prototyping
13+
- **[Coming Soon]** - Sprint planning
14+
- **[Coming Soon]** - Code review for games

docs/index.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1-
# CIS Documentation Index
1+
---
2+
title: Welcome
3+
description: BMad Game Dev Studio - Game development module for Unity, Unreal, and Godot
4+
template: splash
5+
hero:
6+
title: BMad Game Dev Studio
7+
subtitle: Game development (Unity, Unreal, Godot) module
8+
tagline: Build games faster with AI-powered workflows for Unity, Unreal Engine, and Godot.
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-module-game-dev-studio
15+
variant: minimal
16+
---
217

3-
TODO: do more than todo
18+
## Quick Start
19+
20+
[**Tutorials**](/tutorials/) - Step-by-step guides to build games with AI assistance.
21+
22+
[**How-To Guides**](/how-to/) - Practical guides for specific game development tasks.
23+
24+
[**Explanation**](/explanation/) - Learn how BMGD works under the hood.
25+
26+
[**Reference**](/reference/) - Technical reference for configuration and options.
File renamed without changes.

0 commit comments

Comments
 (0)