docs: align image format guidance with WebP CI enforcement#2786
Open
marcel-rbro wants to merge 2 commits into
Open
docs: align image format guidance with WebP CI enforcement#2786marcel-rbro wants to merge 2 commits into
marcel-rbro wants to merge 2 commits into
Conversation
The lint_images CI check requires WebP and rejects PNG/JPG, but the style guide still said PNG for screenshots. Update the standards to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
✅ Preview for this PR (commit |
marcel-rbro
marked this pull request as ready for review
July 20, 2026 09:52
TC-MO
reviewed
Jul 21, 2026
Comment on lines
+208
to
+212
| - **WebP** for screenshots and diagrams | ||
| - **SVG** for logos and icons (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. | ||
|
|
Contributor
There was a problem hiding this comment.
This is not entirely true isn't it? We are remaking Apify-related screenshots into SVGs so it's not only for logos or icons, and we wouldn't be changing it to WebP either.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
lint_imagesCI check requires WebP and rejects PNG, JPG, and other raster formats, but the style guide still told writers to use PNG for screenshots - so following the docs failed the build. This updatescontent-standards.mdandquality-standards.mdto say WebP and points topnpm opt:images.🤖 Generated with Claude Code