7dc3e710b4
Distills the design-language discussion on #3444 into a durable reference: visual language, motion, theming policy, data-freshness/ refresh, error UX, empty states, layout/viewport, component-first design, and attention — plus an open-questions table pointing at the still-unbuilt issues (#3452/#3453/#3454/#3456) instead of asserting them as settled. Mirrors css-vars.md's shape and links to it + to /components rather than duplicating either. First draft for comment, not a final spec.
59 lines
2.9 KiB
Markdown
59 lines
2.9 KiB
Markdown
# Web UI
|
|
|
|
Two web surfaces share the same skeleton: the dashboard (port 7000)
|
|
and the per-agent UIs (each container's port is a deterministic hash
|
|
in :8100-8999 — see
|
|
[`gotchas.md#web-ui-ports-collide-on-hash`](gotchas.md#web-ui-ports-collide-on-hash)
|
|
for the mechanics and the collision caveat).
|
|
Both are SPAs — `GET /` returns a static shell, `/api/state`
|
|
returns JSON, JS renders. No full-page reloads.
|
|
|
|
This doc has been split for readability. Pick the section you need —
|
|
or, if you're the operator looking for how to actually *use* the
|
|
dashboard rather than how it's built, start at
|
|
**[web-ui/README.md](web-ui/README.md)** instead.
|
|
|
|
- **[Shape (shared by both)](web-ui/shape.md)** — shared SPA
|
|
skeleton, SSE multiplexing, terminal pane, listener bind,
|
|
per-agent relative paths, `data-async` form pattern, side panel,
|
|
atomic repaint.
|
|
- **[Dashboard layout](web-ui/dashboard.md)** — tab contents
|
|
(SW4RM, Y3R C4LL, P3RM1SS10NS, SCH3DUL3S) + standalone pages
|
|
(C0R3 `/core.html`, BU1LDS `/builds.html`, L0GS `/logs.html`,
|
|
CR3D3NTIALS `/credentials.html`), container row,
|
|
topology tree, selection bar, approval card, browser
|
|
notifications, dashboard endpoints + event channel.
|
|
- **[Per-agent page](web-ui/agent.md)** — header, main terminal,
|
|
composer, side panel + inbox, live view, slash commands,
|
|
per-agent endpoints, stats page.
|
|
- **[CSS theme variables](web-ui/css-vars.md)** — the Catppuccin
|
|
Mocha custom properties declared once in `base.css` and the rule
|
|
that per-page stylesheets reference (never redeclare) them.
|
|
- **[swarm-ui design guide](web-ui/design-guide.md)** — visual
|
|
language, motion, theming, error-UX, and component-first principles
|
|
for the swarm-level Preact app specifically (not this doc's
|
|
dashboard/agent UIs). `/components` on a running swarm-ui is the
|
|
companion living demo of every primitive it references.
|
|
|
|
## Reading paths
|
|
|
|
- **"How does the dashboard SPA stay live without polling?"** →
|
|
[`web-ui/shape.md`](web-ui/shape.md) (SSE multiplexing,
|
|
Worker-death self-heal, atomic repaint).
|
|
- **"What does a container row contain?"** →
|
|
[`web-ui/dashboard.md`](web-ui/dashboard.md) (Container row,
|
|
Topology tree, Selection bar).
|
|
- **"What endpoints does the dashboard expose?"** →
|
|
[`web-ui/dashboard.md`](web-ui/dashboard.md) (Dashboard
|
|
endpoints, Dashboard event channel).
|
|
- **"How does the per-agent terminal render tool calls?"** →
|
|
[`terminal-rendering.md`](terminal-rendering.md) (full row
|
|
taxonomy + dispatch walkthrough); for a high-level summary see
|
|
[`web-ui/agent.md`](web-ui/agent.md) (Per-stream rendering).
|
|
- **"What slash commands does the agent accept?"** →
|
|
[`web-ui/agent.md`](web-ui/agent.md) (Terminal-embedded prompt).
|
|
- **"What are the per-agent HTTP endpoints?"** →
|
|
[`web-ui/agent.md`](web-ui/agent.md) (Per-agent endpoints).
|
|
- **"Which CSS variable do I use / where are colours defined?"** →
|
|
[`web-ui/css-vars.md`](web-ui/css-vars.md) (Palette, single-source
|
|
`base.css` rule).
|