Skip to content

Screenshot Rules

Use this checklist before adding screenshots to the public site.

Blur or Remove

  • Passwords
  • API keys
  • Tokens
  • Email addresses
  • Private IPs
  • Public IPs
  • MAC addresses
  • Serial numbers
  • Family names
  • Camera views with people visible
  • Home address details
  • Internal-only system names

Good Screenshot Names

Use simple lowercase names with dashes:

dashboard.png
workflow-overview.png
discord-alert.png
container-list.png
network-diagram.png

Where Screenshots Go

Project screenshots should go here:

docs/assets/images/projects/project-name/

Career screenshots should go here:

docs/assets/images/career/

Markdown Image Format

For a project page inside docs/projects, use this format:

![Short image description](../assets/images/projects/project-name/screenshot-name.png)