Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
7472501
🤖 Add mdbook documentation with mermaid and CI/CD
ammario Oct 6, 2025
fd5b654
Fix docs setup issues
ammario Oct 6, 2025
6ef0c4a
Remove architecture docs and update getting started
ammario Oct 6, 2025
118a8e6
Update docs for end users
ammario Oct 6, 2025
e96456e
Add keyboard shortcuts documentation
ammario Oct 6, 2025
e0498d4
Add custom dark theme to docs
ammario Oct 6, 2025
5c112df
Fix sidebar resize handle color
ammario Oct 6, 2025
9c90e61
Remove background color from active sidebar links
ammario Oct 6, 2025
f8a4493
Override mdbook's --bg variable to match bg-primary
ammario Oct 6, 2025
3d6489b
Fix table alternate background and remove theme selector
ammario Oct 6, 2025
161978d
Fix theme selector removal using CSS
ammario Oct 6, 2025
e743ddd
Change sidebar links to use text-primary color
ammario Oct 6, 2025
5bd2007
Make intro.md a symlink to README.md
ammario Oct 6, 2025
b092273
Add CLAUDE.md symlink to docs
ammario Oct 6, 2025
9f6ca2c
Fix CLAUDE.md link for docs compatibility
ammario Oct 6, 2025
3220814
Copy CLAUDE.md instead of symlinking
ammario Oct 6, 2025
8efac91
Restructure: AGENTS.md is now source, CLAUDE.md is symlink
ammario Oct 6, 2025
bfd91cf
Reverse symlink: docs/src/AGENTS.md is now source
ammario Oct 6, 2025
77dd8bc
Add 6px padding to multi-line code blocks
ammario Oct 6, 2025
ae7c086
revise
ammario Oct 6, 2025
e1e72e9
Rename 'Getting Started' to 'Install'
ammario Oct 6, 2025
fe04060
Separate README and docs intro
ammario Oct 6, 2025
3ac71ad
Update docs links to use cmux.io custom domain
ammario Oct 6, 2025
b5f4af8
Simplify docs title and intro content
ammario Oct 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Deploy Docs

on:
push:
branches: ["main"]
paths:
- "docs/**"
- ".github/workflows/docs.yml"
workflow_dispatch: # Allow manual triggering

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: "0.4.52"

- name: Install mdbook-mermaid
run: |
cargo install mdbook-mermaid --version 0.16.0
mdbook-mermaid install docs

- name: Install mdbook-linkcheck
run: cargo install mdbook-linkcheck --version 0.7.7

- name: Build docs
run: cd docs && mdbook build

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/book

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ release

# Documentation
docs/vercel/
docs/book/
docs/mermaid-init.js
docs/mermaid.min.js

# Secrets
.env
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Loading