Rework the GPIO Header LED strip tutorial - #1064
Merged
Merged
Conversation
The YAML told readers to set rmt_channel: 1. ESPHome removed that option from esp32_rmt_led_strip, so copying the block now fails validation. The line and the sentence explaining it are gone, with a note so anyone who copied the old version knows what broke. Images were the other problem. The page carried 22 raw phone photos at 3024x4032, stored twice under two name prefixes, and CI only auto-resizes PNGs so the JPGs shipped full size. That is roughly 17 MB per page load. They are now webp at 1000px on the long edge, one asset set, kebab-case, under 2 MB for the whole page. The AIR-1 GPIO addon photos got the same treatment, so that page drops too. Rewrote both tutorials to the style guide: real headings instead of bold paragraphs, numbered lists instead of "Step 1." pseudo-steps, second person, alt text on every image, and a yaml code fence. The AIR-1 copy now uses AIR-1 wording and AIR-1 photos rather than showing MSR-2 back plate shots. The tutorial existed as five near-identical copies. products/msr2 is now the source and the Homey pages plus the two orphaned copies include it, matching how the rest of the Homey tree already works. Two things left alone deliberately: the 300mA figure here still disagrees with the 350mA on the AIR-1 addon page, and the orphaned URLs are kept alive as includes rather than deleted with redirects. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
Warning Review limit reached
Next review available in: 13 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (54)
📒 Files selected for processing (38)
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 |
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.
What
Reworks the GPIO Header LED strip tutorial and the pages that share it.
The YAML was broken
The block told readers to set
rmt_channel: 1, with a sentence explaining that channel 0 belongs to the built-in LED. ESPHome removedrmt_channelfromesp32_rmt_led_stripentirely, so copying that block now fails validation. Current Apollo firmware declares the built-inrgb_lightwith no channel at all.Removed the option and the explanation, and left a note so anyone who already copied the old block knows why theirs stopped working.
The images were ~17 MB per page load
22 photos, stored twice under two different name prefixes (44 files), most of them straight 3024x4032 phone shots at 0.5 to 1.8 MB each. CI only auto-resizes PNGs, so the JPGs went out at full size.
Now webp at 1000px on the long edge, one asset set, kebab-case names. The whole page is under 2 MB. The AIR-1 GPIO addon photos got the same treatment, which drops that page from roughly 25 MB to 1.3 MB as a side effect.
Across the asset directory this is 60 MB down to 3.3 MB.
Style guide pass
Bold paragraphs became real headings, so the page has sidebar entries for the first time. "Step 1." pseudo-steps became numbered lists. Added alt text to all 22 images, switched the
genericfence toyaml, dropped the hardcoded price and the /<br>cruft, and fixed the run-on lines where two steps and an image were jammed into one sentence.The AIR-1 copy said "MSR-2" throughout and illustrated the install with MSR-2 back plate photos. It now uses AIR-1 wording and the actual AIR-1 photos.
Five copies became one source
The tutorial existed as five near-identical files.
products/msr2is now the source; the Homey pages and the two orphaned copies include it with--8<--, matching the pattern the rest of the Homey tree already uses.Left alone on purpose
products/general/tutorials/...andhomey/products/mtr1/...) are kept alive as includes rather than deleted with redirects.Verified
Checked in a browser against a local build: all images load, all have alt text, the annotation renders, no phantom list items from the indentation, step numbering correct, no horizontal overflow at 390px. Build is clean apart from a pre-existing M-1 link warning unrelated to these pages.
🤖 Generated with Claude Code