Skip to content

Restructure wake-up battery sensor guide with per-device content tabs#883

Merged
bharvey88 merged 1 commit into
devfrom
docs-wake-up-battery-content-tabs
May 27, 2026
Merged

Restructure wake-up battery sensor guide with per-device content tabs#883
bharvey88 merged 1 commit into
devfrom
docs-wake-up-battery-content-tabs

Conversation

@bharvey88
Copy link
Copy Markdown
Contributor

@bharvey88 bharvey88 commented May 27, 2026

What does this implement/fix?

Restructures the wake-up battery sensor guide into a device-per-tab layout (mkdocs-material content tabs) and extends it beyond TEMP-1B/PLT-1B to also cover BTN-1, H-1, and H-2.

  • Single source of truth in products/general/battery-sensors/wake-up-battery-sensor.md; each device tab holds both wake methods (reset button, boot button) with that device's photos.
  • H-1 and H-2 tabs carry a "smart firmware only" note linking to their flashing guides.
  • Converts the Homey general page from a full duplicate into a --8<-- snippet wrapper of the main file (one place to edit going forward).
  • Adds wrapper pages + nav entries for BTN-1 (main + Homey), H-1, and H-2 (main). Homey has no H-1/H-2 sections, so those are main-only.
  • Renames the H-1 flashing page products/h1/code.mdproducts/h1/reflash.md for consistency with H-2, and updates every reference (nav, boot-mode, getting-started, the new wake-up tab). No redirect added — old /products/h1/code/ links break intentionally, per decision.
  • Fixes the H-1 flashing page, which was a stale MTR-1 copy: repoints four screenshots from the dead github.io/docs/products/mtr1/assets/... URLs to their existing local /assets/ copies and removes leftover "MTR-1" wording.

Previewed locally with mkdocs serve; all affected pages build and render with no new warnings.

Types of changes

  • Typo / wording fix
  • Content update (correcting outdated info, adding missing steps, clarifications)
  • New page or new product section
  • Page move / rename (redirect added in mkdocs.yml)
  • Image / screenshot update
  • Nav / structure change
  • Site config or theme change
  • CI / workflows / dependencies — Does not publish

Checklist:

  • This PR targets the dev branch (not main)
  • Changes previewed locally with mkdocs serve
  • If pages were moved or renamed, redirects were added to mkdocs.yml
  • If new pages were added, nav was updated in mkdocs.yml

Summary by CodeRabbit

  • Documentation
    • Enhanced battery sensor wake-up guides with device-specific instructions and tabbed layouts for easier reference.
    • Added "How To Wake Up Your Sensor" navigation links for BTN-1, H-1, and H-2 products.
    • Updated H-1 documentation links and image references for consistency.
    • Consolidated wake-up documentation across product variants.

Review Change Stack

Rework the wake-up battery sensor article into a device-per-tab layout
covering TEMP-1B, PLT-1B, BTN-1, H-1, and H-2. Both wake methods (reset
button, boot button) now live in each device tab with that device's
photos. H-1 and H-2 tabs carry a "smart firmware only" note linking to
their flashing guides.

- Convert the Homey general page from a full duplicate into a snippet
  wrapper of the main file so there is a single source of truth.
- Add wrapper pages and nav entries for BTN-1 (main + Homey), H-1, and
  H-2 (main) so each device section links to the wake guide.
- Rename the H-1 flashing page from /products/h1/code to
  /products/h1/reflash for consistency with H-2; update all references
  (nav, boot-mode, getting-started, wake-up tab). No redirect added.
- Fix the H-1 flashing page: repoint four screenshots from the dead
  github.io MTR-1 asset URLs to their local /assets copies and remove
  leftover MTR-1 wording.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 27, 2026

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR consolidates duplicated battery sensor wake-up instructions into a single shared documentation page with device-specific sections, converts product-specific pages to include-based wrappers, updates navigation to expose the new pages, and corrects H-1 documentation links and image references from external and outdated URLs to local assets.

Changes

Battery Sensor Documentation Refactoring

Layer / File(s) Summary
General battery sensor wake-up page restructure
docs/products/general/battery-sensors/wake-up-battery-sensor.md
Wake-up instructions are restructured from generic "Method 1/Method 2" format into device-specific sections for TEMP-1B, PLT-1B, BTN-1, H-1, and H-2 with tailored button descriptions, device images, and boot-mode links; post-wake guidance directs users to Home Assistant "Prevent Sleep" or device web server.
Product-specific pages converted to include wrappers
docs/products/btn1/battery-sensors/wake-up-battery-sensor.md, docs/products/h1/battery-sensors/wake-up-battery-sensor.md, docs/products/h2/battery-sensors/wake-up-battery-sensor.md, docs/homey/products/btn1/battery-sensors/wake-up-battery-sensor.md, docs/homey/products/general/battery-sensors/wake-up-battery-sensor.md
Product documentation pages are converted to thin wrappers using --8<-- include directives that pull the shared general battery sensor wake-up instructions, eliminating duplicate content across variants.
Navigation configuration updates
mkdocs.yml
Wake-up sensor pages are added to navigation under BTN-1 (Home Assistant and Homey sections) and under H-1 and H-2 "Additional Info" sections; H-1 "Factory Re-Flash" nav target is corrected from products/h1/code.md to products/h1/reflash.md.
H-1 documentation link and image corrections
docs/products/h1/boot-mode.md, docs/products/h1/getting-started.md, docs/products/h1/reflash.md
H-1 boot-mode and getting-started links are updated from /products/h1/code/ to /products/h1/reflash/; reflash.md embedded images are switched from external URLs to local /assets/ paths and MTR-1 device reference is corrected to H-1.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • ApolloAutomation/docs#714: Converts shared documentation pages into wrapper files using --8<-- include directives with corresponding mkdocs.yml nav updates, directly aligned with this PR's consolidation approach.
  • ApolloAutomation/docs#692: Updates boot-mode documentation link targets to the /reflash/ path for H-2, parallel to this PR's H-1 boot-mode link corrections.

Poem

🐰 Content shared, files now lean,
Includes wrapping what was repeated twice—
H-1's old links now point just right,
Device photos from assets, not distant sites,
One source of truth, the refactor's delight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and concisely summarizes the primary structural change: reorganizing the wake-up battery sensor documentation into a device-specific tabbed layout format.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-wake-up-battery-content-tabs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@bharvey88 bharvey88 merged commit 803edf0 into dev May 27, 2026
1 check was pending
@bharvey88 bharvey88 deleted the docs-wake-up-battery-content-tabs branch May 27, 2026 19:47
@bharvey88 bharvey88 mentioned this pull request May 27, 2026
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant