AgentMux docs

The documentation site for AgentMux — a desktop terminal multiplexer for AI coding agents.

Live: https://docs.agentmux.ai

Stack

• Astro + Starlight — static MPA, no client-side router.
• Content lives in src/content/docs/*.md (Markdown with frontmatter).
• Sidebar / nav is configured in astro.config.mjs.
• TypeScript API reference is generated by TypeDoc from the AgentMux source via the src/agentmux submodule.
• Rust crate reference is generated by cargo doc.

Run locally

git clone --recurse-submodules https://github.com/agentmuxai/agentmux-docs
cd agentmux-docs
npm install
npm run dev          # → http://localhost:4321

If you didn't clone with --recurse-submodules:

git submodule update --init --recursive

Build

npm run build        # Fast iterative build. Skips TypeDoc + rustdoc.
npm run build:full   # Production build. Generates TypeScript + Rust references.

Use build:full before any production deploy — build is fine for iterating on docs styling and content.

Contributing

Pull requests welcome. Page-level tips:

• New page: drop a .md / .mdx file under src/content/docs/, then wire it into the sidebar in astro.config.mjs.
• Theme changes: edit src/styles/custom.css. Test both dark AND light mode — Starlight's gray scale inverts between them. See CLAUDE.md for details.
• Assets: site logos / illustrations go in src/assets/ (Astro optimizes them). Favicons go in public/ (served as-is).
• Reference content: the TypeScript and Rust API docs are regenerated from source. Don't hand-edit anything under src/content/docs/api/typescript/ or public/api/rust/ — those directories are rewritten on each build:full.

Content accuracy is sourced from the AgentMux app code. Cross-check the running source in src/agentmux/ (the submodule) before describing behavior.

For internal deployment info (S3 / CloudFront / invalidation steps), see CLAUDE.md.

License

Documentation content is published under the same license as AgentMux itself.