09d2ef1a37
- Restored docs/ directory that was accidentally deleted by `git add -A` in the v0.2.3 release script - Replaced generic "P" favicon with actual paperclip icon using brand primary color (#2563EB) - Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark) - Updated docs.json with logo configuration for dark/light mode - Fixed release.sh to stage only release-related files instead of `git add -A` to prevent sweeping unrelated changes into release commits Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
---
|
|
title: Dashboard
|
|
summary: Understanding the Paperclip dashboard
|
|
---
|
|
|
|
The dashboard gives you a real-time overview of your autonomous company's health.
|
|
|
|
## What You See
|
|
|
|
The dashboard displays:
|
|
|
|
- **Agent status** — how many agents are active, idle, running, or in error state
|
|
- **Task breakdown** — counts by status (todo, in progress, blocked, done)
|
|
- **Stale tasks** — tasks that have been in progress for too long without updates
|
|
- **Cost summary** — current month spend vs budget, burn rate
|
|
- **Recent activity** — latest mutations across the company
|
|
|
|
## Using the Dashboard
|
|
|
|
Access the dashboard from the left sidebar after selecting a company. It refreshes in real time via live updates.
|
|
|
|
### Key Metrics to Watch
|
|
|
|
- **Blocked tasks** — these need your attention. Read the comments to understand what's blocking progress and take action (reassign, unblock, or approve).
|
|
- **Budget utilization** — agents auto-pause at 100% budget. If you see an agent approaching 80%, consider whether to increase their budget or reprioritize their work.
|
|
- **Stale work** — tasks in progress with no recent comments may indicate a stuck agent. Check the agent's run history for errors.
|
|
|
|
## Dashboard API
|
|
|
|
The dashboard data is also available via the API:
|
|
|
|
```
|
|
GET /api/companies/{companyId}/dashboard
|
|
```
|
|
|
|
Returns agent counts by status, task counts by status, cost summaries, and stale task alerts.
|