Skip to content

docs: align image format guidance with WebP CI enforcement #2786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcel-rbro wants to merge 2 commits into
base: master
Choose a base branch
from
+7 −6
Open

docs: align image format guidance with WebP CI enforcement #2786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a69375
docs: align image format guidance with WebP CI enforcement
marcel-rbro Jul 20, 2026
0b7a6a0
docs: note SVG use for product images
marcel-rbro Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions standards/content-standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ FROM apify/actor-node-playwright:22
All images must include meaningful alt text describing the content:

```markdown
![Apify Console showing the Actor creation dialog](./images/create-actor.png)
![Apify Console showing the Actor creation dialog](./images/create-actor.webp)
```

### Theme
Expand All @@ -205,9 +205,10 @@ Use red boxes or arrows to highlight important UI elements:

### Image format

- **PNG** for screenshots and diagrams
- **JPG** for photos
- **SVG** for logos and icons (when available)
- **WebP** for screenshots and diagrams
- **SVG** for logos, icons, and product images (when available)

New raster images must be WebP. The `lint_images` CI check fails on PNG, JPG, and other raster formats. Convert and optimize an image - or a whole directory - with `pnpm opt:images <path>`, then update your Markdown to reference the resulting `.webp` file.

Comment thread
marcel-rbro marked this conversation as resolved.
### File organization

Expand All @@ -218,7 +219,7 @@ platform/
├── actors/
│ ├── running.md
│ └── images/
│ └── run-button.png
│ └── run-button.webp
```

## Lists
Expand Down
2 changes: 1 addition & 1 deletion standards/quality-standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Before submitting documentation, verify:
- [ ] Screenshots use light theme
- [ ] Red indicators used to highlight UI elements
- [ ] Images stored in `images/` subdirectory
- [ ] Image format is appropriate (PNG for screenshots, SVG for logos)
- [ ] Image format is appropriate (WebP for screenshots, SVG for logos)

### File organization

Expand Down
Loading