Skip to content

Commit 107ffdc

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 cis-docs.bmad-method.org - Update README with documentation link
1 parent 14f577d commit 107ffdc

22 files changed

Lines changed: 1504 additions & 6 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+
cis-docs.bmad-method.org

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,10 @@ CIS includes team configurations for collaborative creativity:
8282

8383
## Documentation
8484

85-
- [BMad Method Docs](http://docs.bmad-method.org)
86-
- [Creative Workflows Guide](http://docs.bmad-method.org/how-to/creative-workflows/)
85+
**[Creative Intelligence Suite Documentation](http://cis-docs.bmad-method.org)** — Tutorials, how-to guides, and reference
86+
87+
- [Getting Started](http://cis-docs.bmad-method.org/tutorials/)
88+
- [BMad Method Docs](http://docs.bmad-method.org) — Core framework documentation
8789

8890
## Community
8991

docs/explanation/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Explanation
3+
description: Learn how CIS works
4+
---
5+
6+
# Explanation
7+
8+
Learn how the Creative Intelligence Suite works under the hood.
9+
10+
## Key Concepts
11+
12+
- **[Coming Soon]** - Understanding creative workflows
13+
- **[Coming Soon]** - Brainstorming techniques
14+
- **[Coming Soon]** - Problem-solving approaches

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 CIS tasks
4+
---
5+
6+
# How-To Guides
7+
8+
Step-by-step guides for completing specific tasks with the Creative Intelligence Suite.

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: Creative Intelligence Suite - Innovation, brainstorming, and problem-solving agents
4+
template: splash
5+
hero:
6+
title: Creative Intelligence Suite
7+
subtitle: Innovation, brainstorming, and problem-solving agents
8+
tagline: Unlock your creative potential with AI-powered ideation and problem-solving workflows.
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-creative-intelligence-suite
15+
variant: minimal
16+
---
217

3-
TODO: do more than todo
18+
## Quick Start
19+
20+
[**Tutorials**](/tutorials/) - Step-by-step guides to explore creative workflows.
21+
22+
[**How-To Guides**](/how-to/) - Practical guides for specific tasks.
23+
24+
[**Explanation**](/explanation/) - Learn how CIS 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 CIS
4+
---
5+
6+
# Reference
7+
8+
Technical documentation for Creative Intelligence Suite configuration and options.

docs/tutorials/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Tutorials
3+
description: Step-by-step tutorials for Creative Intelligence Suite
4+
---
5+
6+
# Tutorials
7+
8+
Learn the Creative Intelligence Suite through step-by-step tutorials.
9+
10+
## Quick Start
11+
12+
- **[Coming Soon]** - Your first creative workflow

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-creative-intelligence-suite",
4+
"type": "module",
45
"version": "0.1.4",
56
"description": "A BMad MEthod Core Module that offers a suite of very creative agents and workflows",
67
"keywords": [
@@ -16,6 +17,9 @@
1617
"main": "",
1718
"bin": {},
1819
"scripts": {
20+
"docs:build": "node tools/build-docs.mjs",
21+
"docs:dev": "astro dev --root website",
22+
"docs:preview": "astro preview --root website",
1923
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
2024
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
2125
"lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",

0 commit comments

Comments
 (0)