Skip to content

Commit 408c7fc

Browse files
Kasper Jungeclaude
authored andcommitted
docs: fix dashboard page to match current 3-tab UI so users see accurate documentation
The dashboard was redesigned from 4 tabs (Prompts, Timeline, Configure, History) to 3 tabs (Runs, Configure, History), but the docs still described the old layout. Users opening the dashboard would see a completely different UI than what the docs showed. This rewrites the tab descriptions, updates cross-references in the getting-started tutorial, and adds the Prompts drill-down screenshot. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 34c22f7 commit 408c7fc

2 files changed

Lines changed: 36 additions & 34 deletions

File tree

docs/dashboard.md

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -60,24 +60,16 @@ ralph ui --host 0.0.0.0 --port 9000
6060

6161
## Dashboard tabs
6262

63-
The dashboard has four tabs. **Prompts** is the default landing page.
63+
The dashboard has three tabs: **Runs**, **Configure**, and **History**.
6464

65-
### Prompts
66-
67-
The Prompts tab shows every named prompt discovered in `.ralph/prompts/` as a
68-
card grid. Each card displays:
69-
70-
- **Name** and **description** (from the prompt's frontmatter)
71-
- A **content preview** of the prompt body
72-
- An **Edit** button that opens an inline editor
73-
- A **Run** button that opens the New Run modal with that prompt pre-selected
74-
75-
Use this tab to quickly browse your prompts, start a run from a specific one,
76-
or create new prompts without leaving the browser.
65+
### Runs
7766

78-
### Timeline
67+
The Runs tab is the default landing page. When no runs are active, it shows an
68+
onboarding view with three steps — Configure, Launch, Monitor — and a prominent
69+
**+ New Run** button to get you started.
7970

80-
Select a run in the sidebar to see its iterations as they complete:
71+
Once a run is active, select it in the sidebar to see its iterations as they
72+
complete:
8173

8274
- Pass/fail status with color-coded badges
8375
- Agent output (truncated to 5,000 characters, same as the CLI)
@@ -92,41 +84,51 @@ Events stream over WebSocket, so the page updates without refreshing.
9284

9385
### Configure
9486

95-
The Configure tab lists all checks, contexts, and instructions in your project.
87+
The Configure tab is your central hub for managing all primitives. The overview
88+
shows four cards — **Prompts**, **Checks**, **Contexts**, and **Instructions**
89+
each displaying how many items exist.
9690

9791
<figure markdown="span">
9892
![Configure tab overview](assets/dashboard/configure-tab.png){ loading=lazy }
9993
<figcaption>The Configure overview shows all four primitive types with counts. Click any card to drill in.</figcaption>
10094
</figure>
10195

102-
You can:
103-
104-
- View the frontmatter and body of each primitive
105-
- Edit the **command** and **timeout** fields for checks and contexts directly in the form
106-
- Toggle primitives on and off with enable/disable badges
107-
- Create new primitives
108-
- Edit existing ones
109-
- Delete primitives you no longer need
110-
111-
Click into a primitive type to see its items and edit them inline:
96+
Click into any primitive type to see its items. Each list shows the name,
97+
command (for checks and contexts), and enabled status:
11298

11399
<figure markdown="span">
114100
![Checks list in Configure](assets/dashboard/configure-checks.png){ loading=lazy }
115101
<figcaption>Drill into Checks to see each check's command and enabled status.</figcaption>
116102
</figure>
117103

104+
Click an item to open its editor, where you can:
105+
106+
- Edit the **description**, **command**, and **timeout** fields
107+
- Toggle the **enabled** switch
108+
- Edit the **content** (failure instructions for checks, static content for contexts)
109+
- **Delete** the primitive entirely
110+
- **Create new** primitives with the button at the top of each list
111+
118112
<figure markdown="span">
119113
![Editing a check](assets/dashboard/check-editor.png){ loading=lazy }
120114
<figcaption>Click a check to edit its command, timeout, failure instruction, and enabled toggle.</figcaption>
121115
</figure>
122116

117+
The Prompts section works the same way — browse, create, edit, and delete named
118+
prompts without leaving the browser:
119+
120+
<figure markdown="span">
121+
![Prompts list in Configure](assets/dashboard/configure-prompts.png){ loading=lazy }
122+
<figcaption>Drill into Prompts to browse and manage your named prompts.</figcaption>
123+
</figure>
124+
123125
Changes are written directly to the `.ralph/` directory on disk.
124126

125127
### History
126128

127-
Shows all past runs organized by status — completed, stopped, and failed. Each
128-
run displays its pass rate and iteration count. Click any run to jump to the
129-
Timeline view and see its full iteration details.
129+
Shows all past runs — completed, stopped, and failed. Each run displays its
130+
pass rate and iteration count. Click any run to review its full iteration
131+
details.
130132

131133
## Starting a run
132134

@@ -148,7 +150,7 @@ Click **New Run** in the sidebar to open the run modal. It lets you:
148150
</figure>
149151

150152
Once a run starts, you can **pause**, **resume**, or **stop** it from the
151-
sidebar or the controls bar above the Timeline.
153+
sidebar or the controls bar above the iteration view on the Runs tab.
152154

153155
## Editing while a run is active
154156

docs/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -346,10 +346,10 @@ ralph ui
346346

347347
Open [http://127.0.0.1:8765](http://127.0.0.1:8765) in your browser. From there you can:
348348

349-
- **Browse and edit named prompts** on the Prompts tab
350-
- **Start, pause, and stop runs** with a click
351-
- **Watch iterations complete in real time** via the Timeline tab — check results stream in over WebSocket
352-
- **Toggle primitives on/off** and edit their configuration on the Configure tab
349+
- **Start, pause, and stop runs** with a click from the Runs tab
350+
- **Watch iterations complete in real time** — check results stream in over WebSocket
351+
- **Browse and edit all primitives** (prompts, checks, contexts, instructions) on the Configure tab
352+
- **Review past runs** on the History tab
353353

354354
The dashboard uses the same `run_loop()` engine as the CLI, so everything works exactly the same — it's just a different interface.
355355

0 commit comments

Comments
 (0)