Guardian Device Docs

Media Style Guide ​

Use this format across all endpoint docs so screenshots and videos stay consistent.

Folder convention ​

text
docs/assets/http/
docs/assets/sftp/
docs/assets/mqtt/

File naming convention ​

  • <protocol>-camera-settings.png
  • <protocol>-test-<action>.mp4

Examples:

  • http-camera-settings.png
  • http-test-send.mp4
  • sftp-test-transfer.mp4
  • mqtt-test-publish.mp4

Screenshot guidelines ​

  • Capture full relevant panel (avoid unrelated settings)
  • Ensure values are readable at normal zoom
  • Redact sensitive values if ever present
  • Add one screenshot per key step

Video guidelines ​

  • Keep clips short (15–45 seconds)
  • Show: open settings → save → trigger test event → success signal
  • Prefer MP4 (H.264) for compatibility

Reusable embed pattern ​

md
### 1) Camera endpoint settings screen

![<Protocol> endpoint settings](./assets/<protocol>/<file>.png)

> **What to highlight:** <fields>

### 2) Test clip

<video controls width="100%" src="./assets/<protocol>/<file>.mp4">
  Your browser does not support the video tag.
</video>

> **What to show in the clip:** <steps + success signal>