Update boot screen logo file path in LVGL cookbook #5318
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a broken image link in the LVGL cookbook documentation for the ESPHome boot screen example by updating the logo file path from a non-working favicon PNG URL to the correct favicon.ico URL.
Key Changes
- Updates the ESPHome logo URL in the boot screen example to use the correct favicon.ico path
| @@ -1230,7 +1230,7 @@ esphome: | |||
| - lvgl.widget.hide: boot_screen | |||
|
|
|||
| image: | |||
| - file: https://esphome.io/_static/favicon-512x512.png | |||
| - file: https://esphome.io/favicon.ico | |||
There was a problem hiding this comment.
Using favicon.ico for an image that will be resized to 200x200 and converted to RGB565 is problematic. ICO files are typically small (16x16, 32x32) and may not provide sufficient quality when scaled up. Consider using a higher resolution PNG or SVG source image instead.
| - file: https://esphome.io/favicon.ico | |
| - file: https://esphome.io/images/lvgl.png |
Copilot uses AI. Check for mistakes.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughUpdated a single documentation file to change the boot screen image asset URL in the LVGL cookbook. No logic, behavior, or control-flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
content/cookbook/lvgl.md (1)
1233-1236: Use a local static PNG for the logo
favicon.ico contains a 256×256 frame (so downscaling to 200×200 preserves quality), but it still incurs a build-time network fetch. Add a repo-hosted PNG (256×256 or higher) under/imagesand reference it relatively:- - file: https://esphome.io/favicon.ico + - file: /images/esphome-logo.png
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
content/cookbook/lvgl.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/cookbook/lvgl.md
🔇 Additional comments (1)
content/cookbook/lvgl.md (1)
1233-1233: LGTM: broken logo link fixed.Pointing boot_logo to a stable site root favicon is a reasonable quick fix for the example.
Description:
The esphome logo link doesn't work in ESPHome boot screen lvgl example.
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: