Repository navigation
Conversation
Every page now has a title: in its front matter, so the new PR check can require it. Wrapper pages take the title of the page they include; the rest use their H1. All 29 are pages that aren't in the menu (mostly old Homey copies and the LED-1 and H-3 trees). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A new docs-checks workflow runs on PRs into dev and main and reports problems as annotations on the changed lines: - check_markdown.py: front matter title and description, heading levels that skip, more than one H1, images without alt text, and snippet includes that are missing or start inside the included page's front matter. Warns on em dashes and banned filler words. - check_secrets.py: ESPHome API encryption keys, generated OTA passwords, passwords typed into YAML, and common token formats (allows !secret and obvious placeholders). - check_images.py: photos carrying GPS location data. Warns on images over 1.5 MB that the PR adds or changes. - check_links.py: links, #anchors, filename case, and alt text on the built site, including the site-style links MkDocs doesn't validate. All four pass on the current wiki, and each was shown to fail on a planted example of every problem it covers. CONTRIBUTING.md, AGENTS.md, STYLE_GUIDE.md, and tools/docs-checks/README.md explain the checks and how to fix or run them; the style guide now also covers trimming secrets from recordings and stripping photo location data. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ci: add docs checks to every pull request
The LED-1 reflash page linked a WLED-MM beta built for the Adafruit MatrixPortal ESP32-S3 (an M-1 board). The LED-1 is a classic ESP32 (GPIO 22, 25, and 27), so that binary can't flash it. Use install.wled.me in Basic mode instead, then set the LED-1 pins in WLED 16 (Usermods first, because the AudioReactive default WS pin is GPIO 15, then LED & Hardware). The FAQ answer now links the guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Redraw radar-gates-colored.png with all 8 LD2410 gates to 6 m, in the style of ld2410-gate-map.png, and update its alt text on 4 pages. - Replace the MTR-1 Bluetooth screenshot on the Homey R PRO-1 zones page with a real R PRO-1 web page capture and drop the "Shown on" caption. - Resize plt-boot-mode-pic-4.jpg from 3024x4032 (3.6 MB) to 750 px wide. - TEMP Pro-1 FAQ: PoE is 802.3af, matching the R PRO-1. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Every reflash guide now opens the product's own page on install.apolloautomation.com (#/air-1, #/temp-1, ...) instead of the old apolloautomation.github.io installers. Steps name the variant buttons (USB Power, Battery Power, WiFi, Ethernet, Smart (Wi-Fi)) and Connect & Install exactly as the installer shows them, the firmware option names match the current manifests, and each page gets a new screenshot of its installer page. - TEMP-1B and PLT-1B use their parent's page with Battery Power. - TEMP-1 Revision 1 firmware is only on the classic installer, so the R1 tips link it and name its firmware option. - TEMP Pro-1 isn't on the new installer and keeps its classic link. - Style guide and AGENTS.md: new rule for installer links. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
docs: link reflash guides to the new Apollo installer
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review: 1
Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
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
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.
Publishes what's on dev to the live wiki.
tools/docs-checks/), plus front matter titles on 29 pages.🤖 Generated with Claude Code