Skip to content

Commit 2e98dcd

Browse files
milliondreamsclaude
andcommitted
feat: Add screenshots to documentation and landing page
- Captured screenshots of all main views (Dashboard, List, Thread, Graph) - Added screenshot gallery section to landing page with hover effects - Updated README with visual screenshots in table layout - Created automated screenshot capture script using Playwright - Updated user guide with actual screenshot descriptions - Added 4 high-quality screenshots showing real application UI 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 6c22be7 commit 2e98dcd

10 files changed

Lines changed: 306 additions & 97 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,46 @@ A comprehensive web-based debugging tool for RusticAI's Redis messaging system.
1313
- **Thread View**: Track message threads and conversations
1414
- **Developer Presence**: See which developers are currently monitoring
1515

16+
## Screenshots
17+
18+
<div align="center">
19+
20+
### Dashboard - Guild Overview
21+
![Dashboard View](docs/src/assets/screenshots/dashboard-guilds.png)
22+
*Monitor all active guilds with real-time metrics and message rates*
23+
24+
### Debug Views
25+
26+
<table>
27+
<tr>
28+
<td width="50%">
29+
30+
#### List View
31+
![List View](docs/src/assets/screenshots/debug-list-view.png)
32+
*Chronological message list with filtering*
33+
34+
</td>
35+
<td width="50%">
36+
37+
#### Thread View
38+
![Thread View](docs/src/assets/screenshots/debug-thread-view.png)
39+
*Messages grouped by conversation threads*
40+
41+
</td>
42+
</tr>
43+
<tr>
44+
<td colspan="2">
45+
46+
#### Graph View
47+
![Graph View](docs/src/assets/screenshots/debug-graph-view.png)
48+
*Interactive visualization of message flows between agents*
49+
50+
</td>
51+
</tr>
52+
</table>
53+
54+
</div>
55+
1656
## Architecture
1757

1858
This is a monorepo project using PNPM workspaces:
101 KB
Loading
76.8 KB
Loading
101 KB
Loading
95.6 KB
Loading

docs/src/content/user-guide/screenshots.md

Lines changed: 86 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,26 @@ tags: [screenshots, visual-guide, ui]
88

99
Explore the Rustic Debug interface through these annotated screenshots and visual guides.
1010

11-
## Guild Selection Page
11+
## Dashboard Page
1212

13-
The Guild Selection page is your entry point to debugging. It displays all available RusticAI guilds in your Redis instance.
13+
The Dashboard page is your entry point to debugging. It displays all available RusticAI guilds in your Redis instance with real-time metrics.
1414

15-
![Guild Selection Page](../assets/screenshots/guilds-page.png)
15+
![Dashboard Page - Guilds Overview]
1616

1717
**Key Features:**
1818
- **Guild Cards**: Each guild is displayed as a card showing:
19-
- Guild name and ID
20-
- Number of active topics
21-
- Message count
22-
- Last activity timestamp
23-
- Health status indicator
24-
- **Search Bar**: Filter guilds by name or ID
25-
- **Status Indicators**:
26-
- 🟢 Active guilds with recent messages
27-
- 🟡 Idle guilds with no recent activity
28-
- 🔴 Guilds with errors or issues
29-
- **Quick Actions**: Direct links to debug specific guilds
19+
- Guild name and ID (e.g., "Test Guild" with ID "test_guild_id")
20+
- Number of active topics (e.g., "5 Topics")
21+
- Active agent count (e.g., "0 Agents" when idle)
22+
- Real-time message rate (e.g., "0.0/s")
23+
- Active status indicator (green dot)
24+
- **Summary Statistics Bar**: At the top showing:
25+
- Active Guilds: 6/6
26+
- Total Topics: 51
27+
- Active Agents: 0
28+
- Message Rate: 0.0/s
29+
- **Connection Status**: Top-right indicator showing "Connected (1ms)"
30+
- **Quick Navigation**: Click any guild card to debug its messages
3031

3132
## Debug Dashboard
3233

@@ -42,28 +43,31 @@ The main debugging interface provides comprehensive tools for message analysis.
4243

4344
## Message List View
4445

45-
The List View presents messages in a chronological, filterable table format.
46+
The List View presents messages in a chronological format with topic filtering on the left sidebar.
4647

47-
![List View](../assets/screenshots/list-view.png)
48+
![List View - Chronological Message Display]
4849

4950
**List View Features:**
5051

51-
### Message Table
52-
- **Columns**:
53-
- Timestamp (with millisecond precision)
54-
- Message ID (GemstoneID format)
55-
- Topic
56-
- Agent Tag
57-
- Status (success/error/pending)
58-
- Content preview
59-
- Actions (inspect, replay, export)
60-
61-
### Filtering Panel
62-
- **Time Range**: Last hour, day, week, or custom range
63-
- **Status Filter**: All, Success, Error, Pending
64-
- **Topic Filter**: Multi-select dropdown
65-
- **Agent Filter**: Filter by specific agents
66-
- **Search**: Full-text search in message content
52+
### Topic Sidebar (Left)
53+
- **Topic List** with message counts:
54+
- 📥 initiator (16 messages)
55+
- 📥 responder (14 messages)
56+
- heartbeat (54 messages)
57+
- default topic (107 messages)
58+
- 📥 local test (7 messages)
59+
- Selected topic is highlighted with dark background
60+
61+
### Message Cards (Center)
62+
- **Agent Information**:
63+
- Circular avatar with initial (e.g., "I" for Initiator Agent)
64+
- Agent name and exact timestamp
65+
- **Message Details**:
66+
- Status badge (green "completed" badge)
67+
- Message type (e.g., "SelfReadyNotification")
68+
- JSON payload with syntax highlighting
69+
- Message ID and priority at the bottom
70+
- **Search Bar**: "Search messages, agents, IDs..." for quick filtering
6771

6872
### Message Inspector
6973
When you click on a message, the inspector panel opens:
@@ -87,82 +91,67 @@ When you click on a message, the inspector panel opens:
8791

8892
## Thread View
8993

90-
The Thread View visualizes conversation flows and message chains.
94+
The Thread View groups related messages by conversation thread for easier tracking.
9195

92-
![Thread View](../assets/screenshots/thread-view.png)
96+
![Thread View - Grouped by Conversation]
9397

9498
**Thread Visualization:**
9599

96-
### Thread Timeline
97-
- **Vertical Timeline**: Messages arranged chronologically
98-
- **Thread Connections**: Lines connecting related messages
99-
- **Branch Points**: Where conversations diverge
100-
- **Color Coding**:
101-
- Blue: User messages
102-
- Green: System responses
103-
- Yellow: Processing messages
104-
- Red: Error messages
105-
106-
### Thread Inspector
107-
- **Thread Metadata**:
108-
- Thread ID
109-
- Start time
110-
- Duration
111-
- Message count
112-
- Participating agents
113-
- **Thread Actions**:
114-
- Export thread
115-
- Replay thread
116-
- Share thread link
117-
118-
### Thread Statistics
119-
- **Performance Metrics**:
120-
- Total thread duration
121-
- Average response time
122-
- Number of retries
123-
- Error rate
100+
### Thread Headers
101+
- **Thread Identifier**: Shows truncated thread ID (e.g., "Thread: 958614409581... (1 messages)")
102+
- **Message Count**: Number of messages in each thread
103+
- **Thread Count Indicator**: "16 messages" and "16 threads" shown at the top
104+
105+
### Thread Content
106+
- **Compact Message Display**: Each thread shows:
107+
- Agent avatar and name
108+
- Timestamp (time only for same-day messages)
109+
- Message type (e.g., "SelfReadyNotification")
110+
- JSON payload preview
111+
- **Chronological Ordering**: Threads are arranged by timestamp
112+
- **Visual Separation**: Each thread is clearly separated for easy scanning
113+
114+
### Benefits of Thread View
115+
- **Context Preservation**: Related messages stay together
116+
- **Conversation Tracking**: Easy to follow request-response patterns
117+
- **Debugging Workflows**: Identify where conversations break or fail
118+
- **Performance Analysis**: See thread durations at a glance
124119

125120
## Graph View
126121

127-
The Graph View provides an interactive visualization of message flows between topics and agents.
122+
The Graph View provides an interactive visualization of message flows using a node-based graph.
128123

129-
![Graph View](../assets/screenshots/graph-view.png)
124+
![Graph View - Interactive Message Flow Visualization]
130125

131126
**Graph Visualization Components:**
132127

133-
### Node Types
134-
- **Guild Node** (Large circle): Central node representing the guild
135-
- **Topic Nodes** (Medium circles): Topics within the guild
136-
- **Agent Nodes** (Small circles): Individual agents
137-
- **Message Nodes** (Dots): Individual messages (optional)
138-
139-
### Edge Types
140-
- **Solid Lines**: Direct message flow
141-
- **Dashed Lines**: Async/delayed messages
142-
- **Thick Lines**: High-traffic routes
143-
- **Red Lines**: Error paths
144-
145-
### Interactive Features
146-
- **Zoom & Pan**: Navigate the graph
147-
- **Node Selection**: Click to see details
148-
- **Filter Controls**: Show/hide node types
149-
- **Layout Options**:
150-
- Hierarchical
151-
- Force-directed
152-
- Circular
153-
- Tree
154-
155-
### Graph Statistics Panel
156-
![Graph Statistics](../assets/screenshots/graph-stats.png)
157-
158-
- **Flow Metrics**:
159-
- Messages per second
160-
- Average latency
161-
- Bottleneck detection
162-
- **Node Statistics**:
163-
- Most active topics
164-
- Busiest agents
165-
- Error hotspots
128+
### Layout Controls (Top Bar)
129+
- **Layout Options**: Toggle between different visualization modes
130+
- Tree layout (hierarchical structure)
131+
- Timeline layout (temporal arrangement)
132+
- Circle layout (radial distribution)
133+
- **View Mode Icons**: Quick access to different visualization styles
134+
135+
### Interactive Canvas
136+
- **Node Visualization**: Messages and agents represented as connected nodes
137+
- **Visual Flow Lines**: Shows message routing and relationships
138+
- **Canvas Controls** (Bottom-right):
139+
- Plus/Minus buttons for zoom in/out
140+
- Fit-to-screen button
141+
- Fullscreen toggle
142+
- Pan controls for navigation
143+
144+
### Graph Features
145+
- **Real-time Updates**: Graph updates as new messages arrive
146+
- **Interactive Exploration**: Click and drag to explore the graph
147+
- **Focus on Context**: Selected topic ("initiator") highlighted in sidebar
148+
- **Visual Hierarchy**: Node size and color indicate importance and type
149+
150+
### Use Cases for Graph View
151+
- **System Architecture Visualization**: Understand how agents communicate
152+
- **Bottleneck Detection**: Identify high-traffic routes
153+
- **Debug Message Routing**: Trace message paths visually
154+
- **Performance Analysis**: See which paths have delays or errors
166155

167156
## Real-time Monitoring
168157

docs/src/index.html

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,51 @@
219219
color: #764ba2;
220220
}
221221

222+
/* Screenshots Section */
223+
.screenshots {
224+
background: white;
225+
border-radius: 16px;
226+
padding: 3rem;
227+
margin: 3rem 0;
228+
box-shadow: 0 20px 40px rgba(0,0,0,0.1);
229+
}
230+
.screenshots h2 {
231+
color: #333;
232+
font-size: 2rem;
233+
margin-bottom: 2rem;
234+
text-align: center;
235+
}
236+
.screenshot-grid {
237+
display: grid;
238+
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
239+
gap: 2rem;
240+
margin-top: 2rem;
241+
}
242+
.screenshot-card {
243+
border-radius: 12px;
244+
overflow: hidden;
245+
box-shadow: 0 4px 12px rgba(0,0,0,0.1);
246+
transition: transform 0.3s, box-shadow 0.3s;
247+
cursor: pointer;
248+
}
249+
.screenshot-card:hover {
250+
transform: translateY(-4px);
251+
box-shadow: 0 8px 24px rgba(0,0,0,0.15);
252+
}
253+
.screenshot-card img {
254+
width: 100%;
255+
height: 200px;
256+
object-fit: cover;
257+
object-position: top;
258+
}
259+
.screenshot-card .caption {
260+
padding: 1rem;
261+
background: #f8f9fa;
262+
font-weight: 600;
263+
color: #555;
264+
text-align: center;
265+
}
266+
222267
/* Footer */
223268
footer {
224269
text-align: center;
@@ -294,6 +339,29 @@ <h3>Read-Only Mode</h3>
294339
</div>
295340
</div>
296341

342+
<!-- Screenshots Section -->
343+
<div class="screenshots">
344+
<h2>📸 See It In Action</h2>
345+
<div class="screenshot-grid">
346+
<a href="./user-guide/screenshots.html" class="screenshot-card">
347+
<img src="./assets/screenshots/dashboard-guilds.png" alt="Dashboard View">
348+
<div class="caption">Dashboard - Guild Overview</div>
349+
</a>
350+
<a href="./user-guide/screenshots.html#message-list-view" class="screenshot-card">
351+
<img src="./assets/screenshots/debug-list-view.png" alt="List View">
352+
<div class="caption">List View - Messages</div>
353+
</a>
354+
<a href="./user-guide/screenshots.html#thread-view" class="screenshot-card">
355+
<img src="./assets/screenshots/debug-thread-view.png" alt="Thread View">
356+
<div class="caption">Thread View - Conversations</div>
357+
</a>
358+
<a href="./user-guide/screenshots.html#graph-view" class="screenshot-card">
359+
<img src="./assets/screenshots/debug-graph-view.png" alt="Graph View">
360+
<div class="caption">Graph View - Flow Visualization</div>
361+
</a>
362+
</div>
363+
</div>
364+
297365
<!-- Documentation Cards -->
298366
<div class="docs-section">
299367
<div class="docs-grid">

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
"eslint": "8.57.0",
2828
"eslint-plugin-react": "^7.37.5",
2929
"eslint-plugin-react-hooks": "^5.2.0",
30+
"playwright": "^1.55.1",
31+
"tsx": "^4.7.0",
3032
"turbo": "^1.11.3"
3133
}
3234
}

pnpm-lock.yaml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)