Screenshots
Adding UI screenshots to documentation
Documentation screenshots help users understand the Danvas interface. This guide covers how to add and manage screenshots effectively.
Screenshot Guidelines
Recommended Tools
- MacOS: Built-in Screenshot (Cmd+Shift+4)
- Vercel Blob: For image hosting and optimization in the app
- Local
/images/folder: For docs-specific screenshots
Requirements
| Requirement | Guidance |
|---|---|
| Format | PNG or JPEG |
| Max size | 5MB |
| Recommended width | 1200-1600px |
| Accessibility | Describe the visible state in alt text |
Adding Screenshots
Place screenshots in apps/docs/public/images/ and reference an existing asset:
Via URL
For screenshots hosted on Vercel Blob or another approved external source:
Recommended Screenshots
AI Chat
- Chat interface with tool response
- Location selector dropdown
- Form submission confirmation
Forms
- Form builder interface
- Field configuration panel
- Form submission success
Reports
- Shift report form
- Manager report with employee reviews
- Slack notification example
Incidents
- Incident list view
- Incident detail with comments
- Escalation confirmation
Admin
- User management table
- Compliance dashboard
- Analytics overview
Annotations
For tutorial screenshots, add annotations in the image editor before publishing. Keep the source screenshot and the annotated screenshot as separate files when both versions are useful.
Placeholder Strategy
Do not publish a missing image path or a fake CSS placeholder. Add the real
asset under apps/docs/public/images/ first, then reference it with descriptive
alt text.
Image Optimization
Files under public/images/ are served as static assets. Plain Markdown and
<img> references are not automatically transformed into optimized Next.js
images; use next/image only in React components that need its optimization
pipeline.