Skip to content

Conversation

@ammario
Copy link
Member

@ammario ammario commented Oct 6, 2025

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

bun docs              # Serve with hot reload + open browser
bun docs:build        # Build static site
bun docs:watch        # Watch for changes

CI/CD

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

@ammario ammario force-pushed the doc branch 5 times, most recently from ced3dd4 to f403cb5 Compare October 6, 2025 16:13
ammario added 23 commits October 6, 2025 12:02
- Initialize mdbook in docs/ directory
- Add mermaid support for diagrams
- Add linkcheck for link validation
- Create example pages (intro, getting started, architecture)
- Add GitHub Actions workflow for auto-deployment to GitHub Pages
- Add bun scripts: docs, docs:build, docs:watch

_Generated with `cmux`_
- Remove generated JS files from git (mermaid-init.js, mermaid.min.js)
- Update GitHub repo URLs from ammarbandukwala to coder
- Add scripts that auto-install mermaid assets if missing
- Add mermaid JS files to .gitignore
- Remove architecture.md (docs are for users not developers)
- Update getting-started.md with install instructions from README
- Remove architecture from SUMMARY.md
- Remove architecture docs (for developers, not users)
- Update getting started with install instructions from README
- Focus on user-facing content only
- Create docs/src/keybinds.md with all keybinds
- Use src/utils/ui/keybinds.ts as source of truth
- Add cross-references in both files to keep them in sync
- Fix intro.md to remove architecture link
- Update SUMMARY.md to include keybinds page
- Create docs/theme/custom.css with app colors
- Use dark background (#1e1e1e) matching app
- Fix table cell alignment to left
- Style code blocks, links, sidebar to match app
- Update book.toml to include custom CSS
- Set .sidebar-resize-handle to #333333 (close to requested #323232)
- Uses existing --bg-tertiary variable
- Keep color change (accent-blue) on active links
- Remove background-color, set to transparent
- Set --bg to use --bg-primary (#1e1e1e)
- Ensures consistency with our custom theme colors
- Override --table-alternate-bg to use --bg-secondary (#262626) instead of blue
- Hide theme selector with theme-toggle = false in book.toml
- Keep single consistent dark theme
- Remove invalid theme-toggle config option
- Hide theme selector with CSS: #theme-toggle and .theme-popup
- Keep single dark theme enforced
- Update .sidebar .chapter li.chapter-item a from text-secondary to text-primary
- Makes sidebar links more visible (#d4d4d4)
- Remove duplicate content in docs/src/intro.md
- Create symlink to README.md as single source of truth
- Keeps docs introduction in sync with repo README
- Create docs/src/CLAUDE.md as symlink to ../../CLAUDE.md
- Add to SUMMARY.md as 'Developer Guide'
- Fixes linkcheck error from README intro
- Makes developer documentation accessible in docs
- Change link from (CLAUDE.md) to (./CLAUDE.md)
- Makes link work correctly when README is symlinked in docs
- Still works fine on GitHub
- mdbook linkcheck forbids symlinks outside root
- Copy file instead to fix linkcheck error
- Note: This creates duplication - need to keep both files in sync
- Rename CLAUDE.md to AGENTS.md (more general name for AI assistants)
- Make CLAUDE.md a symlink to AGENTS.md for backwards compatibility
- Update README.md to reference AGENTS.md
- Update docs to use AGENTS.md instead of CLAUDE.md
- Update SUMMARY.md to title it 'AGENTS' instead of 'Developer Guide'
- docs/src/AGENTS.md is the canonical file (source of truth)
- AGENTS.md at root is symlink to docs/src/AGENTS.md
- CLAUDE.md at root is symlink to docs/src/AGENTS.md (backwards compat)
- Satisfies mdbook linkcheck while maintaining symlink consistency
- Change pre > code padding from 0 to 6px
- Improves readability of code blocks in docs
- Rename getting-started.md to install.md
- Update SUMMARY.md sidebar link
- Change page title from 'Getting Started' to 'Install'
- Break symlink: README and intro.md are now separate files
- README is minimal and links to published docs
- intro.md is comprehensive documentation welcome page
- README focuses on quick start and links out
- Change all docs URLs from coder.github.io/cmux to cmux.io
- Update README.md and docs/README.md
- Change title from 'cmux Documentation' to 'cmux docs'
- Simplify intro.md content
- Update mode references from 'plan/edit/yolo' to 'plan/exec'
- Streamline 'Why cmux?' section
@ammario ammario merged commit 4006e3f into main Oct 6, 2025
6 checks passed
@ammario ammario deleted the doc branch October 6, 2025 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant