Images in documentation
How to prepare a secure image, upload PNG, JPEG or WebP, add alt text and check mobile display.
On this page
The picture is meant to explain a step that is more difficult to describe in text. It should not replace the entire procedure or display more data than the customer needs.
Image preparation
- For a screenshot with text or transparency, use PNG.
- Use JPEG for photographs.
- The editor also accepts WebP; animated images are not supported.
- Trim unnecessary edges and highlight only the explained part.
- Check readability at the width of the article, not just on a large monitor.
Security check before upload
Remove passwords, tokens, verification links, webhook URLs, Ticket ID, personal information, payment information, private identifiers, and unnecessary game coordinates. Uploaded media may be publicly available even when the article is still a draft.
Upload in editor
- On the documentation list, open the article and the correct language.
- Place the cursor where the image should help.
- Use the image button to select a file.
- Fill in meaningful alternative text.
- Save the draft and open the preview.
- Check desktop and mobile views, alt text, and any transparency.
How to write alt text
Describe the meaning of the image in a specific step, for example "Slovak language card and Save draft button". A file name like screenshot-01.png is not useful. The important procedure must also be explained in the text for a person who cannot see the image.
Automatic variants
After uploading, the system will prepare reduced WebP variants with a quality of 80 and maintain transparency. The image will not be enlarged beyond its original dimensions. PNG or JPEG remains as a fallback; with WebP input, PNG fallback is also prepared. Individual sizes therefore do not need to be made by hand.
File Limits
| Property | Limit |
|---|---|
| File size | Maximum 5 MB |
| Total resolution | Maximum 24 megapixels |
| Longer side | Maximum 16,383 pixels |
| Format | PNG, JPEG or WebP without animation |
When the upload fails
Check the format, size and dimensions. Shrink or split a large image into logical slices. Do not manually delete old files and variants - they may still be used in a published or historical revision.