# bmux-docs-site

The bmux documentation website.

## Overview

Built with the HyperChad framework, this crate serves the bmux documentation as
a web application with SPA-like navigation. It pulls type information from
`bmux_cli_schema` and `bmux_config` to auto-generate the CLI and configuration
reference pages.

## Routes

- `/` / `/home` -- landing page
- `/docs/installation` -- build-from-source instructions
- `/docs/quickstart` -- getting started guide
- `/docs/concepts` -- core bmux concepts and architecture mental model
- `/docs/cli` -- auto-generated CLI reference
- `/docs/command-cookbook` -- task-oriented command recipes
- `/docs/kiosk` -- kiosk SSH access and token workflow guide
- `/docs/config` -- auto-generated configuration reference
- `/docs/setup-guide` -- practical setup flows for local/remote/hosted
- `/docs/playbooks` -- headless scripted execution
- `/docs/images` -- terminal image protocol support
- `/docs/troubleshooting` -- debugging and failure triage playbook
- `/docs/operations` -- maintenance and operations workflows
- `/docs/docs-snippet-tags` -- author guide for verified snippets
- `/docs/plugins` -- plugin architecture
- `/docs/bpdl-spec` -- normative BPDL grammar and semantics
- `/docs/plugin-sdk` -- plugin authoring guide
- `/docs/plugin-example` -- walkthrough of the example plugin
- `/docs/plugin-ops` -- plugin operations playbook
- `/docs/plugin-triage-playbook` -- plugin failure triage runbook
- `/docs/plugin-perf-troubleshooting` -- plugin performance troubleshooting
- `/docs/changelog` -- release history
- `/faq` -- frequently asked questions
