Skip to content

SCREENSHOTS.md

Latest commit

 

History

History
63 lines (53 loc) · 2.48 KB

SCREENSHOTS.md

File metadata and controls

63 lines (53 loc) · 2.48 KB

Screenshot Guide

中文 | English

Product screenshots live in docs/screenshots/. General documentation assets, such as the app logo, live in docs/assets/.

Files

  • docs/assets/logo.png
  • docs/screenshots/popup.png
  • docs/screenshots/dashboard.jpeg
  • docs/screenshots/records.jpeg
  • docs/screenshots/analysis.jpeg
  • docs/screenshots/logs.jpeg
  • docs/screenshots/settings.jpeg

Gallery

Popup
Popup screenshot 		Dashboard
Dashboard screenshot
Records
Records screenshot 		Analysis with Markdown Preview
Analysis screenshot with Markdown-rendered report
Logs
Logs screenshot 		Settings
Settings screenshot

Capture Standard

  • Replace existing files in place when the UI changes, so README links stay stable.
  • Capture the popup at its natural extension size. Keep popup.png as the primary README popup image.
  • Capture one full-page desktop screenshot for each primary page: dashboard, records, analysis, logs, and settings.
  • Use publishable data only: demo data, sanitized real examples, or screenshots explicitly approved for public display. Never include API keys, passwords, or other credentials.
  • Prefer PNG for small UI surfaces like popup screens. JPEG is fine for large full-page screenshots.
  • Keep images sharp enough for README display; avoid browser chrome unless it is needed to explain the UI.

README Display Rule

The main README files embed one screenshot for each primary page: popup, dashboard, records, analysis, logs, and settings. Use a compact table layout so the README stays scannable, and keep filenames stable so rendering does not break when screenshots are refreshed.