From 2d9cb7f062c738ef18f8d73a1f1159a7c266caee Mon Sep 17 00:00:00 2001 From: GitHub Copilot Date: Sun, 22 Feb 2026 11:30:51 +0000 Subject: [PATCH] docs --- README.md | 6 ++++-- docs/ARCHITECTURE.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 93942a8..db74895 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ https://github.com/user-attachments/assets/62c52183-83a3-4fb5-97b1-ed001de4f53a - Ghostty WebAssembly terminal engine for fast rendering from [`ghostty-web`](https://github.com/rcarmo/ghostty-web) - Session dashboard with live PNG (or optional SVG) screenshots from [`go-te`](https://github.com/rcarmo/go-te) - Docker watch mode (`webterm-command` / `webterm-theme` labels) -- Docker compose manifest ingestion +- Docker compose manifest ingestion (see `prod.compose.yaml`) - CPU sparkline tiles for compose services - SSE activity updates for fast dashboard refresh - Mobile/touch support with virtual keyboard + draggable keybar @@ -87,8 +87,10 @@ Available themes: `tango`, `xterm`, `monokai`, `monokai-pro`, `ristretto`, `dark ### Compose manifest +Use `prod.compose.yaml` as the canonical multi-session compose example: + ```bash -go run ./cmd/webterm -- --compose-manifest ./docker-compose.yaml +go run ./cmd/webterm -- --compose-manifest ./prod.compose.yaml ``` ## Environment variables diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 81ee8c2..2a0dd47 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -54,7 +54,7 @@ The server resolves static files from: ## Docker integration -- **Compose mode** loads services from a compose manifest and creates tiles for services carrying `webterm-command`. +- **Compose mode** loads services from a compose manifest (see `prod.compose.yaml`) and creates tiles for services carrying `webterm-command`. - **Watch mode** subscribes to Docker events and adds/removes tiles at runtime. - `webterm-theme` controls tile theme; default theme applies if unset. Available themes: `tango`, `xterm`, `monokai`, `monokai-pro`, `ristretto`, `dark`, `light`, `dracula`, `catppuccin`, `nord`, `gruvbox`, `solarized`, `tokyo`, `miasma`, `github`, `gotham`.