Screenshot guide
Use this checklist when capturing the frontend console for docs, partner decks and implementation guides. Prefer a controlled non-production tenant with a representative repository and realistic findings — not empty states.
Place files under docs-site/static/img/screenshots/ using the filenames below,
then reference them as:
Until images exist, docs use “Screenshot to capture” tip callouts so writers know exactly what to shoot.
Capture conventions
- Resolution: 1440×900 or retina 2× of that viewport; crop chrome consistently.
- Theme: one light + one dark set if you publish both; default to the theme your product marketing uses.
- Privacy: blur emails, real org names, live tokens; never show full
uvt_/ WorkOS secrets. - Annotation: optional thin callouts on first-use shots only — don’t clutter.
- Story first: each shot should answer one buyer question (see “Story”).
Priority 1 — tell the product story (must-have)
| File | Console path | What to show | Story / benefit |
|---|---|---|---|
overview.png | / | KPIs, risk trend, recent high findings | One-pane AI risk for the estate |
onboarding.png | /onboarding | Setup checklist mid-progress | Fast time-to-value |
inventory.png | /inventory | AI-BOM rollup by kind + providers + shadow count | “We know what AI we run” |
repos-list.png | /repos | Connected repos with finding counts | Coverage across the org |
repo-detail.png | /repos/[id] | AI-BOM tab + findings + CycloneDX / ingest actions | Repo as governed unit |
findings.png | /findings | Sorted by risk / blast-radius; filters visible | Triage that prioritizes impact |
agents.png | /agents | Agents with owners + approval state | Agents as owned artifacts |
compliance.png | /compliance | Framework list + coverage % / attested % | Auditor-ready proof |
evidence.png | /evidence | Verify result + export affordance | Tamper-evident control |
Priority 2 — developer & integration experience
| File | Where | What to show | Story / benefit |
|---|---|---|---|
cli-scan-terminal.png | Terminal | unveilr scan output (AI-BOM + findings) | Offline DX, no account |
ide-problems.png | VS Code / Cursor | Problems panel + inline diagnostic | Feedback at authoring time |
pr-annotations.png | GitHub PR | SARIF annotation on an added line | Diff-aware PR gate |
scan-action-yaml.png | Docs / repo | unveilr/scan-action workflow snippet in Actions UI | One-block CI integration |
tokens.png | /settings/tokens | Token names / expiry (no secrets) | Safe CI auth |
notifications.png | /settings/notifications | Slack channel configured + Test | Close the loop without watching UI |
integrations-tickets.png | /settings/integrations + finding ticket action | Jira/ServiceNow connected; “Open ticket” | Fits existing ops tooling |
Priority 3 — Govern (runtime) surfaces
| File | Console path | What to show | Story / benefit |
|---|---|---|---|
agent-detail.png | /agents/[id] | Owner, scope, credential status | Deployment gate |
registry.png | /registry | MCP servers/tools approval / quarantine | Approved tool surface |
policies.png | /policies | Allow/deny/approve rules | Operable policy |
approvals.png | /approvals | Pending approval queue | Human-in-the-loop |
sessions.png | /sessions | Call timeline with decisions | Runtime audit |
detections-runtime.png | /detections | Injection / exfil alerts | Live attack visibility |
identity-graph.png | /identity | Graph of agents ↔ tools ↔ identities | NHI / blast-radius narrative |
Priority 4 — Prove & admin
| File | Console path | What to show | Story / benefit |
|---|---|---|---|
compliance-attest.png | /compliance → control detail | Evidence statement + attest UI | Human attestation vs auto-green |
remediation.png | /remediation | Finding → fix / ticket hub | From alert to action |
sso.png | /settings/sso | SSO / SCIM status (no secrets) | Enterprise ready |
org-settings.png | /settings | Org / tenant context | Multi-tenant control plane |
Suggested pairing for a 5-slide implementation briefing
cli-scan-terminal.png+ide-problems.png— developer looppr-annotations.png— CI gateinventory.png+findings.png— Discover / Guard in consoleagents.png+sessions.png— Governcompliance.png+evidence.png— Prove
Embedding in docs
After files land in static/img/screenshots/, replace tip callouts with images,
e.g. on Discover:
*Org-wide AI-BOM with provider breakdown and shadow-AI count.*
Keep alt text outcome-oriented (“Org AI inventory showing shadow MCP count”), not just “screenshot”.