Repository navigation
Conversation
- Write alt text for 1,533 images that had none (markdown ![]() and
<img> tags without alt), across 281 pages and snippets. Writers looked
at 1,254 of the images; an independent reviewer per chunk spot-checked
665 more and corrected 62.
- Replace 211 alt texts that were only a file name ("image.png",
"Alarmo 3.png") or started with "Image of"; reviewers corrected 14.
- Only alt text changed: every file was checked against HEAD with a
script that fails on any other difference.
The built site goes from 2,452 images without alt text to 0.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
One copy-edit pass over all 710 pages, clear errors only (no rewording for style, no technical changes). An independent reviewer per chunk checked every changed hunk against HEAD. - 151 typos (e.g. "sumamry", "Presense", "recieve"), 94 grammar fixes (e.g. "set up" as a verb, "comes", sentence capitals), 7 British to US spellings. - 43 product ID slips (Air-1, temp-1, btn-1, R-Pro-1 -> AIR-1, TEMP-1, BTN-1, R PRO-1) and 191 brand casing slips (esphome, home assistant, WiFi, Github, Youtuber, usb-c, bluetooth -> ESPHome, Home Assistant, Wi-Fi, GitHub, YouTuber, USB-C, Bluetooth). Wi-Fi is the dominant form in the repo (256 vs 64). - Untouched by design: code, YAML, URLs, entity IDs, hostnames, hotspot and device-reported names, on-screen labels, external video titles, and all numbers. A script checked every file against HEAD for this. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add the missing front matter title to 273 pages, from the page's H1 or, for pages without one, its nav label (which MkDocs already shows as the title, so nothing visible changes). - Renumber 431 headings on 134 pages so levels no longer skip (e.g. "##### Method 1" directly under the H1 becomes "## Method 1") and each page keeps one H1. Relative hierarchy is kept, so these sections now appear in the sidebar table of contents. The two landing pages keep their designed heading sizes. - Bump 19 snippet include line offsets so they still start at the same content line after the title insertion. - Fix 4 includes that pulled in another page's front matter, which rendered a stray "description: ..." heading (Homey PLT-1B reviews and Flower Card, Homey MSR-2 mmWave videos, Homey zone configuration). - Replace 14 front matter descriptions that were the literal string ">-" (a flattened YAML folded scalar) with the description of the page they include. - Remove a stray empty code fence in bluetooth-tracking.md that turned the whole Android section (links, 10 steps, 6 screenshots) into one code block, and a stray horizontal rule on the Homey AIR-1 tips page. Verified by diffing the rendered text of all 686 pages before and after: only the 6 pages fixed above changed visible text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Nav only: no page is added, removed, or moved to a new URL. All 736 entries are kept (checked by script). - One section order for every product, in both the Home Assistant and Homey trees: Introduction, FAQ, Getting Started, setup groups, Additional Info, Addons, Examples, Troubleshooting, Reviews. Reviews moved to the end on 9 products; Addons now precede Examples on M-1. - Homey MTR-1 Zone Configuration and Homey MSR-2 Radar Tuning move out of Additional Info to sit after Getting Started, as they do in the Home Assistant tree and for Homey R PRO-1. - Products within a category are alphabetical (mmWave: MSR-1, MSR-2, MTR-1, R PRO-1). - Items within Additional Info, Addons, Examples, Troubleshooting, Battery Sensors, Calibrating, and Example Flows are alphabetical, with General Tips and Sensor Definitions kept first. Sequential sections (Getting Started, ESPHome Starter Kit lessons, Zone Configuration's Good/Better/Best) keep their order. - Labels: PLT-1B troubleshooting entries said "PLT-1" (6 entries, both trees); WiFi -> Wi-Fi (3); Unifi -> UniFi (2). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
docs: wiki cleanup pass (alt text, typos, formatting, nav order)
|
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
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.
Publishes #1152 to the live wiki.
🤖 Generated with Claude Code