docs(heimdall): the submitted icon was wrong, and so was my reason - #290
Merged
Conversation
The submission sent docs/icon.svg -- a square with its own dark background plate -- justified by a claim that logo.svg carried a white background. That claim was wrong. The white rect in logo.svg is inside a <mask>, so it is never painted; the file renders fully transparent, top-left pixel srgba(0,0,0,0). It came from reading the markup when one render would have settled it. It matters because their guidance asks for transparent backgrounds and Heimdall paints its own colour behind the icon, which a plate fights. The Heimdall PR now carries the official transparent mark instead, verified full-bleed and transparent at their 60px tile size.
📝 WalkthroughWalkthroughThe Heimdall submission instructions now use ChangesHeimdall icon documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@contrib/heimdall/README.md`:
- Around line 70-74: Update the README wording describing logo.svg so it says
the image has a transparent background rather than claiming the entire file is
fully transparent. Preserve the top-left pixel detail as evidence of background
transparency, while keeping the visible disc description accurate.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 48a64d4e-03d7-471c-a20d-8265c20c1821
📒 Files selected for processing (1)
contrib/heimdall/README.md
Comment on lines
+70
to
+74
| An earlier version of this file sent `docs/icon.svg` — a square with its own | ||
| dark background plate — and justified it by claiming `logo.svg` carried a white | ||
| background. **That was wrong.** The white rect in `logo.svg` sits inside a | ||
| `<mask>`, so it is never painted; the file renders fully transparent (top-left | ||
| pixel `srgba(0,0,0,0)`). |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify the scope of “fully transparent.”
Line 50 describes a visible disc. The cited top-left pixel proves only that one pixel is transparent. State that logo.svg has a transparent background, not that the entire file is fully transparent.
Proposed wording
- the file renders fully transparent (top-left pixel `srgba(0,0,0,0)`).
+ the rendered icon has a transparent background (top-left pixel `srgba(0,0,0,0)`).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| An earlier version of this file sent `docs/icon.svg` — a square with its own | |
| dark background plate — and justified it by claiming `logo.svg` carried a white | |
| background. **That was wrong.** The white rect in `logo.svg` sits inside a | |
| `<mask>`, so it is never painted; the file renders fully transparent (top-left | |
| pixel `srgba(0,0,0,0)`). | |
| An earlier version of this file sent `docs/icon.svg` — a square with its own | |
| dark background plate — and justified it by claiming `logo.svg` carried a white | |
| background. **That was wrong.** The white rect in `logo.svg` sits inside a | |
| `<mask>`, so it is never painted; the rendered icon has a transparent background (top-left pixel `srgba(0,0,0,0)`). |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@contrib/heimdall/README.md` around lines 70 - 74, Update the README wording
describing logo.svg so it says the image has a transparent background rather
than claiming the entire file is fully transparent. Preserve the top-left pixel
detail as evidence of background transparency, while keeping the visible disc
description accurate.
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
1 participant
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 Heimdall submission sent
docs/icon.svg— a square with its own dark background plate — justified by a claim thatlogo.svgcarried a white background.That claim was wrong. The white rect in
logo.svgis inside a<mask>, so it is never painted. The file renders fully transparent: top-left pixelsrgba(0,0,0,0), mean alpha 0.35.It came from reading the markup when one render would have settled it.
It matters because their guidance explicitly asks for transparent backgrounds, and Heimdall paints its own tile colour behind the icon — a plate fights it. PR #971 now carries the official transparent mark, verified full-bleed and transparent at their real 60px tile size.
Summary by CodeRabbit
docs/logo.svgas the required icon.