Skip to content

Commit c215b1c

Browse files
authored
docs: improve UI documentation (#2)
1 parent b30f83f commit c215b1c

1 file changed

Lines changed: 32 additions & 42 deletions

File tree

docs/src/content/docs/guides/web-ui.md

Lines changed: 32 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -17,60 +17,51 @@ just skit serve
1717
just dev # For development with hot reload
1818
```
1919

20-
## Dashboard Overview
20+
## Main Routes
2121

22-
The UI surfaces:
22+
The Web UI has four main routes:
2323

24-
- **Sessions**: active pipelines and their status
25-
- **Node palette**: built-in nodes + loaded plugins
26-
- **Samples**: runnable example pipelines (from `samples/pipelines/`)
27-
- **Plugins**: upload/unload plugins at runtime (if your role allows it)
24+
- **Design** (default): build and edit pipelines visually.
25+
- **Monitor**: inspect and manage live sessions.
26+
- **Convert**: demo/test **oneshot** pipelines (request → response).
27+
- **Stream**: demo/test **dynamic** pipelines (MOQ-powered streaming sessions).
2828

29-
## Creating a Session
29+
## Design View
3030

31-
1. Click **"New Session"** in the dashboard
32-
2. Enter a name for your session
33-
3. Choose a starting template or start blank
31+
Design View is the default route and is split into three panes:
3432

35-
## Visual Pipeline Editor
33+
- **Left pane**: library and tools:
34+
- **Nodes**: the node palette/library (built-ins + loaded plugins).
35+
- **Plugins**: view/manage loaded plugins (availability depends on your role/config).
36+
- **Samples**: example pipelines you can load as a starting point.
37+
- **Fragments**: reusable building blocks you can drop into a graph.
38+
- **Center pane (canvas)**: a React Flow editor where you:
39+
- Drag and drop nodes onto the canvas.
40+
- Connect nodes by drawing edges between ports.
41+
- Use the right-click context menu for actions like import/export.
42+
- **Right pane**:
43+
- **YAML**: the pipeline definition for the canvas (two-way synced).
44+
- **Inspector** (when a node is selected): inspect/tune that node’s parameters.
3645

37-
### Adding Nodes
46+
### What is a Fragment?
3847

39-
- Drag nodes from the **Node Palette** onto the canvas
40-
- Or right-click the canvas and select from the context menu
48+
A fragment is a reusable mini-graph (a small, pre-wired set of nodes) that you can insert into a larger pipeline. Use fragments to share common patterns (e.g. “input → preprocess → STT”) without rebuilding them by hand.
4149

42-
### Connecting Nodes
50+
## Monitor View
4351

44-
- Click and drag from an **output pin** (right side) to an **input pin** (left side)
45-
- Connections validate automatically based on data types
52+
Monitor View uses the same overall three-pane layout, but focuses on running sessions:
4653

47-
### Node Configuration
54+
- **Left pane**: a live list of sessions until you enter **Staging Mode** (then it switches to the node library/palette for editing).
55+
- **Center pane**: the session graph view.
56+
- **Right pane** (once a session is selected): the YAML editor plus the Inspector pane for selected nodes.
4857

49-
- Click a node to open its **Properties Panel**
50-
- Modify parameters in real-time
51-
- Changes apply immediately to the running pipeline
58+
## Convert View
5259

53-
## Node States
60+
Convert is for demoing/testing **oneshot** pipelines: load or author a pipeline, run it against input media, and review outputs.
5461

55-
Nodes display their current state with visual indicators:
62+
## Stream View
5663

57-
| State | Description |
58-
|-------|-------------|
59-
| `Initializing` | Node is starting up |
60-
| `Ready` | Node is ready; waiting for pipeline start |
61-
| `Running` | Processing normally |
62-
| `Recovering` | Attempting to recover from an error |
63-
| `Degraded` | Running with reduced quality |
64-
| `Failed` | Fatal error |
65-
| `Stopped` | Node stopped (completed or shutdown) |
66-
67-
## Real-time Monitoring
68-
69-
The UI provides live updates via WebSocket:
70-
71-
- **Packet flow** visualization on connections
72-
- **Node metrics** (packets processed, errors)
73-
- **State changes** reflected instantly
64+
Stream is for demoing/testing **dynamic** (long-running) pipelines using MOQ-powered streaming sessions.
7465

7566
## Telemetry Timeline
7667

@@ -105,8 +96,7 @@ nodes:
10596
10697
## Exporting Pipelines
10798
108-
1. Click **"Export"** in the toolbar
109-
2. Save the YAML for sharing/versioning
99+
In Design View, use the canvas right-click context menu to export/import pipelines. The YAML pane is also a convenient way to copy/paste pipelines for sharing/versioning.
110100
111101
To run exported YAML without the UI, send it to the server:
112102

0 commit comments

Comments
 (0)