Repository navigation
docs: wiki cleanup round 2 (technical fixes, Homey rewrites, readability, style, security) - #1165
Merged
Merged
Conversation
Fixes from the wiki audit, each checked against a source before it was applied and re-verified by an independent reviewer (0 reverted, 5 corrected): - Values checked against the product firmware: hotspot names (Apollo TEMP1, TEMP1B, PLT1, PLT1B, MSR2 Hotspot), TEMP-1/TEMP-1B automation YAML that triggered on the Max Probe Temp setting instead of the probe reading, LD2450 zone ranges (X -4860 to 4860, Y 0 to 7560 mm), substitutions: key, power_save_mode under wifi:, SCD40 offset restore_value, the public OTA password replaced with a secret. - Step numbering and cross-references (duplicate step numbers, "repeat steps 7 and 8" pointing at the wrong steps, "image above" pointing at the wrong image). - Wrong product named in text, and text copied from another product's page (TEMP-1 vs TEMP-1B vs TEMP Pro-1, PLT-1 vs PLT-1B, MSR-1/MSR-2). - Homey pages that linked to Home Assistant pages when a Homey page exists, and Homey reflash pages that told readers to remove the device from Home Assistant. - Broken markup and stale wording (old ESPHome UI names, 6 m = 19.7 ft). A follow-up pass applied the same fixes to mirror pages (Home Assistant and Homey copies, product siblings) that the first pass skipped. 38 fixes also need a retaken screenshot; those images are listed in the PR. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Decisions from the site owner, each applied everywhere the value or pattern appears and checked by an independent reviewer: - Specs: TEMP-1/TEMP-1B food probe max 350 °C (662 °F); GPIO Header 5V pin up to 350 mA; R PRO-1 PoE is 802.3af; High CO2 Homey tutorials use 900 ppm for green so the light doesn't flicker around 1000; SmartThings tutorial keeps verify_ssl: false with a security warning; Breakout Module STEMMA QT tab points to the 3.3V port and explains the board's two STEMMA ports. - Homey wording: MSR-2 HLK step uses the sensor's own web page; hidden Wi-Fi page uses the standalone ESPHome Device Builder; MTR-1 tips note that power_save_mode needs ESPHome Device Builder; Sensor Connection Check describes the LED colors for Homey. - Images: 57 "Shown on ..." captions where a screenshot shows another product, two MTR-1 zone screenshots swapped for real MTR-1 ones, the BTN-1 blueprint GIFs removed from the PLT-1 blueprint page, an H-2 store photo showing the four song buttons, and a redrawn LD2410 gate map (all 8 gates to 6 m, meters and feet) and gate table (unit typos fixed) replacing the old MSR-1 images. - LED-1 Govee guide: empty steps removed, "still being written" note. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…rphan pages - Remove MSR-2 and MTR-1 Alarmo, MSR-2 Dashboards, and the PLT-1 and PLT-1B Flower Card from the Homey menu; they only work in Home Assistant. The pages stay reachable by URL. - Delete five orphan Homey copies of Home Assistant pages (MSR-2 and MTR-1 buzzer, MTR-1 Home Assistant dashboard examples, the AIR-1 temperature calibration stub, the MSR-2 quick CO2 page) and the old contact.md placeholder. Each gets a redirect to the closest live page so old links keep working. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Update 52 cells with current specs: prices, radar chips, ranges, zones, target tracking, lux sensors, sizes, and stands for Everything Presence One and Lite, Screek 1U and 2A, and Aqara FP1 and FP2, plus current Apollo MSR-2 and MTR-1 prices and details. Every changed competitor value was confirmed against its source page. - Detection Zones for Screek and Aqara now show real counts (Screek 1U has gates only, 2A has 3 zones + 1 exclusion, FP1 up to 10 regions, FP2 up to 30 zones) instead of repeating the distance. - Regular prices, not temporary sale prices; a dated note says where the values came from. - Retire the stale duplicate table (mmwave-presence-sensor-comparison, both trees, not in the menu) with redirects to the live table. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Homey pages rewritten for Homey, with every card, setting, capability, and label taken from the Apollo Homey app source (and the device firmware), then re-checked claim by claim by an independent reviewer (283 claims): - Prevent Sleep (TEMP-1, TEMP-1B, PLT-1, PLT-1B): the Homey Battery settings for the battery models; the USB-powered TEMP-1 and PLT-1 pages now say plainly that sleep isn't available in Homey and how to recover a unit left asleep. - TEMP-1 and TEMP-1B alert and automation examples rebuilt as Homey Flows using the probe reading cards. - Homey FAQs (AIR-1, BTN-1, MSR-2, MTR-1, PLT-1, PLT-1B, R PRO-1, TEMP-1, TEMP-1B, general): Home Assistant answers rewritten for Homey; product facts kept. - BTN-1: "Turn a Light On and Off" and "Use All Four Buttons" Flow guides replace the Home Assistant automation and blueprint pages. - MSR-2 radar tuning uses the sensor's built-in web page; menu label "Built-in Web Page". Also fixes the Homey TEMP-1 Getting Started page, which rendered blank on the live site because its include started past the end of the file. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pages that scored 1 or 2 out of 5 for readability in the audit,
rewritten so the steps are easy to follow, without changing technical
content:
- Framing sentences before procedures and success lines after them;
prerequisites pulled into "Before you start" notes.
- Tangled and run-on steps split up, unclear references ("the image
above") fixed, duplicated text merged, walls of text broken into
lists, consistent terms, sentence-case headings.
- Every step, value, link, image, and code block kept. A script
checked every page against the previous version (code blocks byte
for byte; removed or added links, URLs, and numbers reported) and an
independent reviewer per batch accounted for each report, reverted
13 hunks that changed meaning or firmed up a hedged claim, and fixed
80 smaller issues. Reviewed pages now score 4 or 5.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- The Home Assistant wake-up page said holding the boot button wakes a sleeping TEMP-1B, PLT-1B, BTN-1, H-1, or H-2. Per each device's firmware the boot button is not a wakeup pin: press reset, or Buttons 1 to 4 on the BTN-1, or the gold button(s) on the H-1 and H-2. - The Homey wake-up page was an include of the Home Assistant page and ended by telling Homey users to press Prevent Sleep in Home Assistant. It is now a Homey page (TEMP-1B, PLT-1B, BTN-1 tabs) using the Homey app's Battery settings, verified against the app source. - Homey BTN-1: the wake-up page now includes the Homey page, the Prevent Sleep page is a Homey page (it included the Home Assistant one), and the two Flow guides no longer need a workaround. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Approved style-guide clean-ups across 237 pages, each chunk checked by
an independent reviewer and a script (no code, link, URL, or number
changes):
- 146 em dashes in prose replaced with commas, periods, colons,
parentheses, or "to" for ranges. Quoted external titles, code, and
table "no value" placeholders are unchanged.
- 102 filler words ("simply", "just", "easy", "powerful",
"seamlessly") removed where they added nothing; kept where they carry
meaning ("just under", "not just", comparatives, quoted titles).
- 199 framing sentences added before step lists that started without
saying what the reader is about to do.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The ESPHome Device Builder rename GIF on the Renaming Apollo Devices page ran into the compile log, which printed the device's full configuration, including a Wi-Fi network name and password in plain text. The GIF now ends when the install starts, before the configuration dump. The renaming steps it illustrates are unchanged. The password was public on the live site and remains in git history, so it should be changed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Converts Title Case headings and front matter titles to sentence case
across 362 pages, as STYLE_GUIDE.md asks: the first word and proper
nouns are capitalized (product IDs, brands, app names, acronyms,
channel names, exact UI labels); everything else is lowercase. The
first word after a colon is capitalized ("Method 1: Boot button only").
Capitalization only: a script checked that no other character changed,
and heading anchors are unchanged because they are generated from
lowercase text. Menu labels in mkdocs.yml are unchanged.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Strip GPS coordinates from the metadata of 194 photos in docs/assets. Every one carried a real location where the photo was taken. Only the GPS tags were removed; the image pixels are unchanged (checked). - Re-cut the Homey Zone Mapper walkthrough video and add-widget clip to start 0.5 s later. Their first frames showed the Homey account card with the owner's full name and email. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A scan of 419 screenshots and animations (8,320 frames) found real ESPHome API encryption keys readable in 8 images: three beta-branch screenshots, a GPIO LED editor screenshot, and four ESPHome Device Builder recordings. Each key value is now covered with a solid box in the editor's background color; the "key:" label and everything else in the image are unchanged. Animations keep their frame count, timing, and palette (only the affected frames were re-encoded). An independent check viewed every affected frame. The keys were public on the live site and remain in git history, so the affected devices should get new API keys. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important Review skippedToo many files! This PR contains 493 files, which is 393 over the limit of 100. To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. Usage-priced reviews support at most 300 files. ⚙️ Run configuration
⛔ Files ignored due to path filters: 208
📒 Files selected for processing: 493
You can disable this status message by setting the
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.
What does this implement/fix?
Round 2 of the wiki cleanup, built from the site owner's answers on the decision sheet (approvals for ready work, style choices, readability scope, and 26 product decisions). Every change was made by agents grounded in a source (product firmware, the Apollo Homey app source, screenshots, manufacturer sites) and checked by an independent reviewer plus scripts that block unintended changes.
Security: actions only you can take
These secrets were public on the live wiki. They are hidden in this PR, but they stay in git history and may be cached, so please rotate them:
rename-hostname-esphome-device-builder-gif.gif(Renaming Apollo Devices) ran into a compile log that printed a real Wi-Fi network name and password. The GIF now ends before the log. Change that network's password.b2e6d4), a GPIO LED editor screenshot (bed-mmwave-sensor), and four ESPHome Device Builder recordings (including the BTN-1smart-keysconfig and the Starter Kit config). Each key is now covered. Generate new API keys on those devices.Lower-severity personal details I did not change (listed under "Needs a human").
What changed, by commit
verify_sslwarning; Breakout Module STEMMA 3.3V port; Homey wording (MSR-2 web page, standalone Device Builder, LED colors); 57 "Shown on ..." captions; MTR-1 zone screenshots swapped for real MTR-1 ones; BTN-1 GIFs removed from the PLT-1 blueprint page; H-2 store photo of the song buttons; redrawn LD2410 gate map (all 8 gates to 6 m, meters and feet) and gate table; LED-1 Govee "still being written" note.contact.md).Verification
devmkdocs buildwarnings and errorsNeeds a human
Screenshots to retake (text is already fixed; the image still shows the old state or another product):
restore_value: trueline.radar-gates-colored.png(zone-colored gate diagram): still shows 7 gates to 5 m.plt-boot-mode-pic-4.jpgis 3.6 MB (3024x4032); a smaller export would load faster.Homey details I couldn't confirm from the app source (pages use the same wording as existing accurate Homey pages; worth a quick look in the app): the exact tap path to a device's Settings, whether settings need a Save tap, Homey's built-in Logic and Push Notification card names in the mobile app, and how to insert a token in a notification.
Homey app bug: the Sleep duration setting is labeled in hours, but the USB-powered TEMP-1 and PLT-1 firmware reads it as minutes (the battery models use hours). The app currently refuses battery settings on the USB models, so it only matters if that changes.
Not decided or unconfirmed:
docs/snippets/matrix-yaml-generator.htmalso generatesverify_ssl: falsewithout a warning.Low-severity personal details in images (not changed): household first names in Home Assistant device and area names, home Wi-Fi network names (no passwords), a Windows username in build-log paths, Music Assistant usernames, and personal browser bookmarks (including a torrent tracker) in
m-1-esphome-firmware-installed-no-wifi.jpgandr-pro-1-ld2412-gate-sliders-webserver.gif. Retake or crop any you'd rather not show.Readability: the 303 pages that scored 3 out of 5 ("usable but bumpy") were not rewritten; this round covered the 96 hardest as you chose.
Types of changes
mkdocs.yml)Checklist:
devbranch (notmain)mkdocs serve(verified with fullmkdocs buildruns and a link checker instead)mkdocs.ymlmkdocs.yml🤖 Generated with Claude Code