Commit 4006e3f
authored
π€ Add mdbook documentation with mermaid and CI/CD (#42)
## Overview
Sets up fast-building documentation using **mdbook** with mermaid
diagram support and automatic deployment to GitHub Pages.
## Features
- β
**mdbook** - Rust-based, blazingly fast builds
- β
**Mermaid diagrams** - Visual architecture documentation
- β
**Link checking** - Validates all links during build
- β
**GitHub Pages CI/CD** - Auto-deploys on push to main
- β
**Example pages** - Introduction, Getting Started, Architecture
## Commands Added
```bash
bun docs # Serve with hot reload + open browser
bun docs:build # Build static site
bun docs:watch # Watch for changes
```
## CI/CD
- `.github/workflows/docs.yml` triggers on docs/ changes
- Deploys to https://ammarbandukwala.github.io/cmux
- Can be manually triggered
## Structure
```
docs/
βββ book.toml # Config (mermaid + linkcheck)
βββ README.md # Documentation for contributors
βββ src/
β βββ SUMMARY.md # Table of contents
β βββ intro.md
β βββ getting-started.md
β βββ architecture.md # With mermaid diagrams
βββ book/ # Build output (gitignored)
```
---
_Generated with `cmux`_1 parent 4d944e2 commit 4006e3f
File tree
18 files changed
+938
-429
lines changed- .github/workflows
- docs
- src
- theme
- scripts
- src/utils/ui
18 files changed
+938
-429
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
65 | 68 | | |
66 | 69 | | |
67 | 70 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
0 commit comments