Docs: screenshots pattern

Problem to solve

Create a pattern to take screenshots of the UI.

Further details

Currently, we don't have a standard for screenshots, which makes them inconsistent through our docs.

Proposal

Work with UX folks to look into it and define some standards for screenshots.

Things to consider:

  • The portion of the UI
  • Nav menus (when/whether include / not include)
  • Ratio (2:1, 3:1, etc?)
  • Size (MB)
  • System fonts (macOS vs Linux)
  • Navigation theme
  • Syntax highlighting theme
  • What else?

Also, document:

  • How to take the screenshot (suggest tools)
  • How to compress them

Who can address the issue

Docs team + UXers

Other links/references

For reference, I had this idea during the UX weekly call this Tuesday as they're planning to have satndards for UI dashboards. I think we could plan the same for our screenshots.

Edited Sep 29, 2025 by 🤖 GitLab Bot 🤖
Assignee Loading
Time tracking Loading