Skip to content

Commit 5612e60

Browse files
centdixclaude
andauthored
docs: replace ASCII diagrams with Mermaid-rendered SVGs in README (#39)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 362f446 commit 5612e60

3 files changed

Lines changed: 8 additions & 17 deletions

File tree

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -172,20 +172,9 @@ If your `.workmux.yaml` has `auto_name.model` configured, the create-worktree di
172172

173173
## Architecture
174174

175-
```
176-
Browser (localhost:5111)
177-
178-
├── REST API (/api/*) ──┐
179-
└── WebSocket (/ws/*) ──┤
180-
181-
Backend (Bun HTTP server)
182-
183-
┌──────────────┼──────────────┐
184-
│ │ │
185-
workmux CLI tmux sessions Docker
186-
(worktree (terminal (sandbox
187-
lifecycle) access) containers)
188-
```
175+
<p align="center">
176+
<img src="docs/architecture.svg" alt="Architecture diagram" />
177+
</p>
189178

190179
**Backend** — Bun/TypeScript HTTP + WebSocket server (`backend/src/server.ts`):
191180

@@ -196,9 +185,9 @@ Browser (localhost:5111)
196185

197186
### Terminal streaming
198187

199-
```
200-
Browser (xterm.js) ←— WebSocket —→ Backend ←— stdin/stdout pipes —→ script (PTY) ←— tmux attach —→ tmux grouped session
201-
```
188+
<p align="center">
189+
<img src="docs/terminal-streaming.svg" alt="Terminal streaming diagram" />
190+
</p>
202191

203192
When a worktree is selected, the frontend opens a WebSocket to `/ws/<worktree>`. The backend spawns a PTY via `script` and attaches to a **grouped tmux session** — a separate view into the same windows. This allows the dashboard and a real terminal to view the same worktree simultaneously.
204193

docs/architecture.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)