Skip to content

Commit b643a63

Browse files
Kasper Jungeclaude
authored andcommitted
docs: add dashboard screenshots so users can see the UI before installing
The dashboard page was entirely text-based with no visual references. Added 8 annotated screenshots covering the Runs tab, Configure overview, checks list and editor, New Run dialog with settings, and mobile layout. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 067d35f commit b643a63

9 files changed

Lines changed: 38 additions & 0 deletions
71.5 KB
Loading
70.8 KB
Loading
76.9 KB
Loading
105 KB
Loading
37.5 KB
Loading
68.1 KB
Loading
87.7 KB
Loading

docs/assets/dashboard/runs-tab.png

77.3 KB
Loading

docs/dashboard.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ ralph ui
4242

4343
The dashboard opens at [http://127.0.0.1:8765](http://127.0.0.1:8765).
4444

45+
<figure markdown="span">
46+
![Ralphify dashboard — Runs tab](assets/dashboard/runs-tab.png){ loading=lazy }
47+
<figcaption>The Runs tab is your starting point for launching and monitoring autonomous loops.</figcaption>
48+
</figure>
49+
4550
| Option | Default | Description |
4651
|-----------|---------------|--------------------------|
4752
| `--port` | `8765` | Port to serve the UI on |
@@ -88,6 +93,12 @@ Events stream over WebSocket, so the page updates without refreshing.
8893
### Configure
8994

9095
The Configure tab lists all checks, contexts, and instructions in your project.
96+
97+
<figure markdown="span">
98+
![Configure tab overview](assets/dashboard/configure-tab.png){ loading=lazy }
99+
<figcaption>The Configure overview shows all four primitive types with counts. Click any card to drill in.</figcaption>
100+
</figure>
101+
91102
You can:
92103

93104
- View the frontmatter and body of each primitive
@@ -97,6 +108,18 @@ You can:
97108
- Edit existing ones
98109
- Delete primitives you no longer need
99110

111+
Click into a primitive type to see its items and edit them inline:
112+
113+
<figure markdown="span">
114+
![Checks list in Configure](assets/dashboard/configure-checks.png){ loading=lazy }
115+
<figcaption>Drill into Checks to see each check's command and enabled status.</figcaption>
116+
</figure>
117+
118+
<figure markdown="span">
119+
![Editing a check](assets/dashboard/check-editor.png){ loading=lazy }
120+
<figcaption>Click a check to edit its command, timeout, failure instruction, and enabled toggle.</figcaption>
121+
</figure>
122+
100123
Changes are written directly to the `.ralph/` directory on disk.
101124

102125
### History
@@ -114,6 +137,16 @@ Click **New Run** in the sidebar to open the run modal. It lets you:
114137
- **Enter an ad-hoc prompt** — toggle to ad-hoc mode and type a one-off task
115138
- **Configure settings** — expand the settings panel to set max iterations, delay between iterations, timeout, and stop-on-error
116139

140+
<figure markdown="span">
141+
![New Run dialog](assets/dashboard/new-run-dialog.png){ loading=lazy }
142+
<figcaption>Pick a named prompt or write an ad-hoc one. The Settings panel is collapsed by default.</figcaption>
143+
</figure>
144+
145+
<figure markdown="span">
146+
![New Run with settings expanded](assets/dashboard/new-run-settings.png){ loading=lazy }
147+
<figcaption>Select a prompt and expand Settings to configure iterations, delay, timeout, and stop-on-error before launching.</figcaption>
148+
</figure>
149+
117150
Once a run starts, you can **pause**, **resume**, or **stop** it from the
118151
sidebar or the controls bar above the Timeline.
119152

@@ -161,6 +194,11 @@ wide), the sidebar collapses into a slide-out drawer — tap the hamburger menu
161194
open it and the overlay to close it. Controls and spacing tighten further below
162195
600px so the dashboard remains usable on a phone.
163196

197+
<figure markdown="span">
198+
![Mobile dashboard view](assets/dashboard/mobile-view.png){ width="360" loading=lazy }
199+
<figcaption>On phones, the sidebar collapses and the layout stacks vertically.</figcaption>
200+
</figure>
201+
164202
## REST API
165203

166204
The dashboard exposes a REST API you can use to script runs, manage primitives,

0 commit comments

Comments
 (0)