Fix wrong sidebar on pages shared across nav sections#714
Conversation
MkDocs assigns each .md file to only one nav section (last occurrence wins), so pages referenced in multiple sections showed the wrong sidebar. Created snippet wrapper files using --8<-- includes so each nav entry points to a unique file path while sharing the same content. Affects ~25 pages across General, MSR-1/2, MTR-1, TEMP-1/1B, PLT-1/1B, H-1/2, and their Homey counterparts. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThis PR reorganizes documentation across multiple product sections by consolidating content using include directives and updating navigation paths in mkdocs.yml. Zone configurations, sensor guides, setup instructions, and calibration content are migrated to general or product-specific paths, with corresponding navigation entries updated to reflect the new structure. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 18
🤖 Fix all issues with AI agents
In `@docs/homey/products/general/contact-us/contact-us-support.md`:
- Line 1: This wrapper page starts with an include directive and triggers lint
rule MD041; fix it by adding markdownlint suppression around that include in
contact-us-support.md (wrap or precede the include directive with a markdownlint
disable for MD041 and re-enable it after the include) so the wrapper is ignored
by the MD041 rule while other content remains linted.
In `@docs/homey/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md`:
- Line 1: This wrapper file triggers MD041 because it's an include-only wrapper;
fix it by adding a top-level heading at the top of the file (e.g., a single line
starting with "# " followed by a descriptive title) so the document has a
primary heading, or alternatively add a markdownlint rule disable for MD041 in
this file (e.g., a front-matter or inline disable) if you intentionally want an
include-only wrapper; update the file "adding-90-degree-usb-c-to-msr-2.md"
accordingly.
In `@docs/homey/products/msr2/calibrating-and-updating/mmwave-videos.md`:
- Line 1: This wrapper file currently only contains an include marker (--8<--
"homey/products/general/calibrating-and-updating/mmwave-videos.md") which trips
markdownlint MD041; fix by either adding a top-level heading (e.g., add a first
line like "# mmWave videos" above the include) or disable the rule for this file
by adding a markdownlint directive (<!-- markdownlint-disable MD041 -->) at the
top; update the wrapper msr2/calibrating-and-updating/mmwave-videos.md
accordingly so CI linting no longer reports MD041.
In `@docs/homey/products/plt1b/battery-sensors/wake-up-battery-sensor.md`:
- Line 1: Add a local markdownlint directive to disable MD041 around the
include-only wrapper so the file can remain an include without duplicating
headings; specifically, insert <!-- markdownlint-disable MD041 --> as the very
first line, keep the existing include line (--8<--
"homey/products/general/battery-sensors/wake-up-battery-sensor.md"), and then
add <!-- markdownlint-enable MD041 --> immediately after the include to
re-enable the rule. This preserves the wrapper pattern and satisfies linting by
scoping the disable to this file.
In `@docs/homey/products/plt1b/calibrating-plt1.md`:
- Line 1: This wrapper file starts with an include which triggers markdownlint
rule MD041; add a top-level heading line at the very top of calibrating-plt1.md
(e.g. "# Calibrating PLT1" or another appropriate H1) so the file no longer
begins with an include, or alternatively add a per-file markdownlint disable for
MD041 if a heading is inappropriate; ensure the heading is placed before the
existing include line.
In `@docs/homey/products/plt1b/reviews.md`:
- Line 1: This wrapper file is include-only and triggers markdownlint MD041
(missing first-line heading); fix it by either adding a file-level markdownlint
disable for MD041 at the top of this wrapper file to skip the H1 check for
include-only wrappers, or add an explicit H1 heading as the first line; target
the wrapper file named reviews.md and ensure the change is applied at the file
top so markdownlint no longer reports MD041.
In `@docs/homey/products/plt1b/setup/getting-started-plt1.md`:
- Line 1: This wrapper file (getting-started-plt1.md) currently lacks a
top-level heading and triggers markdownlint MD041; add a top-level H1 heading at
the top of the file (for example a concise title like "Getting Started — PLT1")
so the include-only wrapper passes lint, or alternatively add an MD041 disable
directive if you intentionally want no heading; update the file header
accordingly to resolve the lint failure.
In `@docs/homey/products/temp1/battery-sensors/sensor-connection-check.md`:
- Line 1: This wrapper file currently starts with an include and triggers
markdownlint MD041; fix it by either adding a top-level H1 (e.g., "# Battery
sensor connection check") at the very top of the file or suppressing the rule
for the file by adding a file-level markdownlint directive (<!--
markdownlint-disable MD041 -->) before the include so MD041 is disabled for this
wrapper file.
In `@docs/homey/products/temp1/battery-sensors/wake-up-battery-sensor.md`:
- Line 1: This file is failing MD041 because the include is the first line; fix
it by wrapping the include-only line with local markdownlint directives: add
<!-- markdownlint-disable MD041 --> immediately before the include and <!--
markdownlint-enable MD041 --> immediately after so the wrapper pattern is
preserved without duplicating headings; update the include-only wrapper file
(the one that only contains the include) to contain those two comments around
the include.
In `@docs/homey/products/temp1b/battery-sensors/sensor-connection-check.md`:
- Line 1: This wrapper markdown currently lacks a top-level heading triggering
MD041; add a single H1 heading at the very top of the file (for example "#
Sensor connection check" or an appropriate title) so the wrapper file satisfies
markdownlint MD041 and keeps the document valid for inclusion with
"homey/products/general/battery-sensors/sensor-connection-check.md".
In `@docs/products/msr1/calibrating-and-updating/mmwave-videos.md`:
- Line 1: Add a local markdownlint directive to disable MD041 around the
include-only wrapper so the include line (the "--8<--" include-only pattern) can
remain the first line without triggering the rule; place a markdownlint-disable
MD041 comment immediately before the include-only line and a markdownlint-enable
MD041 comment immediately after the include so the rule is only disabled for
this wrapper.
In `@docs/products/plt1b/battery-sensors/awake-ha-helper.md`:
- Line 1: This file is an include-only wrapper that triggers markdownlint MD041
because the include is the first line; wrap the existing include marker (the
line containing --8<-- "products/general/battery-sensors/awake-ha-helper.md")
with local markdownlint disable/enable comments to silence MD041 (e.g., add a
markdownlint-disable MD041 comment immediately before the include and
markdownlint-enable MD041 immediately after) so the wrapper pattern is preserved
without duplicating headings.
In `@docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md`:
- Line 1: This file is failing MD041 because the include is the first line; fix
it by adding markdownlint directives to disable MD041 around the include
wrapper: add <!-- markdownlint-disable MD041 --> as the very first line, keep
the existing include line, and then add <!-- markdownlint-enable MD041 --> after
it (in wake-up-battery-sensor.md) so the rule is locally suppressed without
duplicating headings.
In `@docs/products/plt1b/examples/flower-card.md`:
- Line 1: This wrapper-only include file (flower-card.md) is flagged by
markdownlint MD041 for missing a top-level heading; fix it by either adding a
local markdownlint suppression for MD041 at the top of the include file
(preferred for wrapper-only snippets) or by adding a minimal H1 heading (e.g., a
single-line "# ..." title) to satisfy the rule; update the wrapper include
(flower-card.md) accordingly so the linter stops reporting MD041.
In `@docs/products/temp1/battery-sensors/awake-ha-helper.md`:
- Line 1: This file triggers MD041 for missing top-level heading; either add an
H1 heading at the very top of awake-ha-helper.md (a clear title line beginning
with "# ") or insert a markdownlint suppression comment to disable MD041 for the
file (e.g., a top-of-file HTML comment disabling MD041) so the linter stops
flagging it; update the same file (awake-ha-helper.md) accordingly and commit
the change.
In `@docs/products/temp1/battery-sensors/sensor-connection-check.md`:
- Line 1: This file triggers MD041 (missing top-level heading); either add a
top-level H1 at the top of sensor-connection-check.md (e.g., "# Sensor
connection check" or an appropriate title) or add a lint suppression comment at
the top to disable MD041 for this file (e.g., an HTML comment or
markdownlint-disable directive) so the wrapper pattern no longer fails the
linter; update the file header accordingly to resolve the lint error.
In `@docs/products/temp1b/battery-sensors/awake-ha-helper.md`:
- Line 1: This wrapper file lacks a top-level heading and triggers MD041; to
fix, add a single H1 heading at the very top of awake-ha-helper.md (e.g., "Awake
HA helper" or similar descriptive title) so the file is not an include-only
wrapper, or alternatively add an MD041 disable directive if a heading is
inappropriate—update the file header accordingly to satisfy the linter.
In `@docs/products/temp1b/battery-sensors/sensor-connection-check.md`:
- Line 1: Add a top-level heading to this wrapper file to satisfy markdownlint
MD041; update sensor-connection-check.md by inserting a H1 title (e.g., "Sensor
Connection Check" or the equivalent descriptive heading) at the very top of the
file (or alternatively add an MD040/MD041 disable directive if you must skip
linting) so the wrapper referencing
"products/general/battery-sensors/sensor-connection-check.md" has a top-level
heading.
🧹 Nitpick comments (1)
docs/products/temp1b/setup/temp1-general-tips.md (1)
1-1: Consider silencing MD041 for include-only wrappers.If markdownlint is enforced, this file will keep emitting MD041 because the first line is an include directive. Add a file-level disable to avoid noisy warnings.
🔧 Proposed fix
+<!-- markdownlint-disable MD041 --> --8<-- "products/temp1/setup/temp1-general-tips.md"
| @@ -1 +1 @@ | |||
| --8<-- "products/general/contact-us/contact-us-support.md" | |||
| --8<-- "products/general/contact-us/contact-us-support.md" | |||
There was a problem hiding this comment.
Suppress MD041 for include-only wrapper to avoid lint noise.
If markdownlint is enforced, these wrapper pages will warn because the first line is an include directive. Consider disabling MD041 in this wrapper file.
💡 Suggested tweak
+<!-- markdownlint-disable MD041 -->
--8<-- "products/general/contact-us/contact-us-support.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/general/contact-us/contact-us-support.md" | |
| <!-- markdownlint-disable MD041 --> | |
| --8<-- "products/general/contact-us/contact-us-support.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/homey/products/general/contact-us/contact-us-support.md` at line 1, This
wrapper page starts with an include directive and triggers lint rule MD041; fix
it by adding markdownlint suppression around that include in
contact-us-support.md (wrap or precede the include directive with a markdownlint
disable for MD041 and re-enable it after the include) so the wrapper is ignored
by the MD041 rule while other content remains linted.
| !!! success "You're ready to begin using your device!" | ||
|
|
||
| Make sure to head to our <a href="https://wiki.apolloautomation.com/products/general/setup/getting-started-msr2/" target="_blank" rel="noreferrer nofollow noopener">getting started guide</a> to get your MSR-2 up and running! No newline at end of file | ||
| --8<-- "products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md" |
There was a problem hiding this comment.
Address MD041 for wrapper file.
Include-only wrappers violate MD041. Add a top-level heading (or disable MD041 for this file) if linting is enforced.
💡 Suggested fix (add heading)
+# Adding 90° USB‑C to MSR‑2
--8<-- "products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md" | |
| # Adding 90° USB‑C to MSR‑2 | |
| --8<-- "products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/homey/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md` at line
1, This wrapper file triggers MD041 because it's an include-only wrapper; fix it
by adding a top-level heading at the top of the file (e.g., a single line
starting with "# " followed by a descriptive title) so the document has a
primary heading, or alternatively add a markdownlint rule disable for MD041 in
this file (e.g., a front-matter or inline disable) if you intentionally want an
include-only wrapper; update the file "adding-90-degree-usb-c-to-msr-2.md"
accordingly.
| @@ -0,0 +1 @@ | |||
| --8<-- "homey/products/general/calibrating-and-updating/mmwave-videos.md" | |||
There was a problem hiding this comment.
Address MD041 for wrapper file.
If markdownlint runs in CI, add a top-level heading (or disable MD041 for this file) so the include-only wrapper doesn’t trip lint.
💡 Suggested fix (add heading)
+# mmWave Videos
--8<-- "homey/products/general/calibrating-and-updating/mmwave-videos.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "homey/products/general/calibrating-and-updating/mmwave-videos.md" | |
| # mmWave Videos | |
| --8<-- "homey/products/general/calibrating-and-updating/mmwave-videos.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/homey/products/msr2/calibrating-and-updating/mmwave-videos.md` at line
1, This wrapper file currently only contains an include marker (--8<--
"homey/products/general/calibrating-and-updating/mmwave-videos.md") which trips
markdownlint MD041; fix by either adding a top-level heading (e.g., add a first
line like "# mmWave videos" above the include) or disable the rule for this file
by adding a markdownlint directive (<!-- markdownlint-disable MD041 -->) at the
top; update the wrapper msr2/calibrating-and-updating/mmwave-videos.md
accordingly so CI linting no longer reports MD041.
| @@ -0,0 +1 @@ | |||
| --8<-- "homey/products/general/battery-sensors/wake-up-battery-sensor.md" | |||
There was a problem hiding this comment.
Address MD041 warning for include-only wrapper.
If markdownlint is enforced, this file will keep failing MD041 because the include is the first line. Consider disabling MD041 locally to preserve the wrapper pattern without duplicating headings.
💡 Suggested fix
+<!-- markdownlint-disable MD041 -->
--8<-- "homey/products/general/battery-sensors/wake-up-battery-sensor.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "homey/products/general/battery-sensors/wake-up-battery-sensor.md" | |
| <!-- markdownlint-disable MD041 --> | |
| --8<-- "homey/products/general/battery-sensors/wake-up-battery-sensor.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/homey/products/plt1b/battery-sensors/wake-up-battery-sensor.md` at line
1, Add a local markdownlint directive to disable MD041 around the include-only
wrapper so the file can remain an include without duplicating headings;
specifically, insert <!-- markdownlint-disable MD041 --> as the very first line,
keep the existing include line (--8<--
"homey/products/general/battery-sensors/wake-up-battery-sensor.md"), and then
add <!-- markdownlint-enable MD041 --> immediately after the include to
re-enable the rule. This preserves the wrapper pattern and satisfies linting by
scoping the disable to this file.
| @@ -0,0 +1 @@ | |||
| --8<-- "homey/products/plt1/calibrating-plt1.md" | |||
There was a problem hiding this comment.
Address MD041 for wrapper file.
Markdownlint flags wrapper files that start with an include. If linting is enforced, add a top-level heading (or disable MD041 for this file).
💡 Suggested fix (add heading)
+# Calibrating PLT-1
--8<-- "homey/products/plt1/calibrating-plt1.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "homey/products/plt1/calibrating-plt1.md" | |
| # Calibrating PLT-1 | |
| --8<-- "homey/products/plt1/calibrating-plt1.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/homey/products/plt1b/calibrating-plt1.md` at line 1, This wrapper file
starts with an include which triggers markdownlint rule MD041; add a top-level
heading line at the very top of calibrating-plt1.md (e.g. "# Calibrating PLT1"
or another appropriate H1) so the file no longer begins with an include, or
alternatively add a per-file markdownlint disable for MD041 if a heading is
inappropriate; ensure the heading is placed before the existing include line.
| @@ -0,0 +1 @@ | |||
| --8<-- "products/plt1/examples/flower-card.md" | |||
There was a problem hiding this comment.
Address markdownlint MD041 for wrapper include.
Lint flags missing top-level heading. For wrapper-only include files, consider suppressing MD041 locally (preferred) or add a minimal H1 to satisfy the rule.
🧩 Example local suppression (markdownlint)
+<!-- markdownlint-disable MD041 -->
--8<-- "products/plt1/examples/flower-card.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/plt1/examples/flower-card.md" | |
| <!-- markdownlint-disable MD041 --> | |
| --8<-- "products/plt1/examples/flower-card.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/products/plt1b/examples/flower-card.md` at line 1, This wrapper-only
include file (flower-card.md) is flagged by markdownlint MD041 for missing a
top-level heading; fix it by either adding a local markdownlint suppression for
MD041 at the top of the include file (preferred for wrapper-only snippets) or by
adding a minimal H1 heading (e.g., a single-line "# ..." title) to satisfy the
rule; update the wrapper include (flower-card.md) accordingly so the linter
stops reporting MD041.
| @@ -0,0 +1 @@ | |||
| --8<-- "products/general/battery-sensors/awake-ha-helper.md" | |||
There was a problem hiding this comment.
Suppress MD041 or add a top-level heading.
This wrapper likely triggers MD041 in markdownlint. Add an H1 or disable MD041 for this file to keep linting clean.
🧰 Suggested lint suppression
+<!-- markdownlint-disable MD041 -->
--8<-- "products/general/battery-sensors/awake-ha-helper.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/general/battery-sensors/awake-ha-helper.md" | |
| <!-- markdownlint-disable MD041 --> | |
| --8<-- "products/general/battery-sensors/awake-ha-helper.md" |
🤖 Prompt for AI Agents
In `@docs/products/temp1/battery-sensors/awake-ha-helper.md` at line 1, This file
triggers MD041 for missing top-level heading; either add an H1 heading at the
very top of awake-ha-helper.md (a clear title line beginning with "# ") or
insert a markdownlint suppression comment to disable MD041 for the file (e.g., a
top-of-file HTML comment disabling MD041) so the linter stops flagging it;
update the same file (awake-ha-helper.md) accordingly and commit the change.
| @@ -0,0 +1 @@ | |||
| --8<-- "products/general/battery-sensors/sensor-connection-check.md" | |||
There was a problem hiding this comment.
Suppress MD041 or add a top-level heading.
Same wrapper pattern triggers MD041. Please add an H1 or disable MD041 in this file.
🧰 Suggested lint suppression
+<!-- markdownlint-disable MD041 -->
--8<-- "products/general/battery-sensors/sensor-connection-check.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/general/battery-sensors/sensor-connection-check.md" | |
| <!-- markdownlint-disable MD041 --> | |
| --8<-- "products/general/battery-sensors/sensor-connection-check.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/products/temp1/battery-sensors/sensor-connection-check.md` at line 1,
This file triggers MD041 (missing top-level heading); either add a top-level H1
at the top of sensor-connection-check.md (e.g., "# Sensor connection check" or
an appropriate title) or add a lint suppression comment at the top to disable
MD041 for this file (e.g., an HTML comment or markdownlint-disable directive) so
the wrapper pattern no longer fails the linter; update the file header
accordingly to resolve the lint error.
| @@ -0,0 +1 @@ | |||
| --8<-- "products/general/battery-sensors/awake-ha-helper.md" | |||
There was a problem hiding this comment.
Address MD041 for wrapper file.
Include-only wrappers typically violate MD041. Add a top-level heading (or disable MD041 for this file) to keep lint clean.
💡 Suggested fix (add heading)
+# Awake HA Helper
--8<-- "products/general/battery-sensors/awake-ha-helper.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/general/battery-sensors/awake-ha-helper.md" | |
| # Awake HA Helper | |
| --8<-- "products/general/battery-sensors/awake-ha-helper.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/products/temp1b/battery-sensors/awake-ha-helper.md` at line 1, This
wrapper file lacks a top-level heading and triggers MD041; to fix, add a single
H1 heading at the very top of awake-ha-helper.md (e.g., "Awake HA helper" or
similar descriptive title) so the file is not an include-only wrapper, or
alternatively add an MD041 disable directive if a heading is
inappropriate—update the file header accordingly to satisfy the linter.
| @@ -0,0 +1 @@ | |||
| --8<-- "products/general/battery-sensors/sensor-connection-check.md" | |||
There was a problem hiding this comment.
Address MD041 for wrapper file.
To satisfy markdownlint MD041, add a top-level heading (or disable MD041 for this file).
💡 Suggested fix (add heading)
+# Sensor Connection Check
--8<-- "products/general/battery-sensors/sensor-connection-check.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "products/general/battery-sensors/sensor-connection-check.md" | |
| # Sensor Connection Check | |
| --8<-- "products/general/battery-sensors/sensor-connection-check.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/products/temp1b/battery-sensors/sensor-connection-check.md` at line 1,
Add a top-level heading to this wrapper file to satisfy markdownlint MD041;
update sensor-connection-check.md by inserting a H1 title (e.g., "Sensor
Connection Check" or the equivalent descriptive heading) at the very top of the
file (or alternatively add an MD040/MD041 disable directive if you must skip
linting) so the wrapper referencing
"products/general/battery-sensors/sensor-connection-check.md" has a top-level
heading.
All wrapper files using --8<-- includes were pulling in the source file's YAML front matter (title/description), which would render as raw text. Adding :5: starts the include from line 5, matching the existing pattern used by all other homey wrapper files.
There was a problem hiding this comment.
Actionable comments posted: 2
Note
Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.
🤖 Fix all issues with AI agents
In
`@docs/homey/products/general/calibrating-and-updating/zone-configuration/zones-hlk.md`:
- Line 1: The include directive uses a sliced reference (--8<--
"homey/products/mtr1/setup/zones-hlk.md:5:") which skips the actual heading;
edit that include in zones-hlk.md to remove the ":5:" slice (or change it to
":1:") so the file is included from the start and the "###### Configure Zones"
heading and subsequent note are not omitted; update the line containing the
--8<-- include marker to reference "homey/products/mtr1/setup/zones-hlk.md"
without the incorrect slice.
In `@docs/products/temp1b/setup/temp1-general-tips.md`:
- Line 1: Update the slice range in the include directive that references
"products/temp1/setup/temp1-general-tips.md:5:" to use ":6:" instead of ":5:" so
the YAML front matter (lines 1–6) is fully skipped and content begins at line 7;
modify the string "products/temp1/setup/temp1-general-tips.md:5:" to
"products/temp1/setup/temp1-general-tips.md:6:" wherever it appears.
🟡 Minor comments (23)
docs/products/apolloodroid/bluetoothtracking.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorMD041 warning on wrapper-only file (consider local disable or minimal heading).
This include-only wrapper will trip MD041 (“first line should be a top-level heading”). If markdownlint is enforced, either suppress MD041 for this file or add a minimal heading to satisfy the rule without duplicating the included content.
🛠️ Option A: local markdownlint disable
+<!-- markdownlint-disable MD041 --> --8<-- "general/setup/bluetooth-tracking.md:5:"docs/homey/products/msr2/calibrating-and-updating/mmwave-videos.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAdd a trailing newline to satisfy MD047.
The file should end with a single newline to pass markdownlint.
✏️ Proposed fix
--8<-- "homey/products/general/calibrating-and-updating/mmwave-videos.md:5:" +docs/homey/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAdd the trailing newline to satisfy MD047.
The file currently lacks a final newline, which trips markdownlint MD047.
🧾 Proposed fix
--8<-- "products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md:5:" +docs/products/plt1b/setup/getting-started-plt1.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSuppress MD041 for wrapper-only files.
This wrapper has no visible heading by design, so markdownlint will keep warning on every build. Consider disabling MD041 locally to avoid noise without changing output.
✅ Suggested fix (lint-only)
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/setup/getting-started-plt1.md:5:"docs/homey/products/general/contact-us/YouTube.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAdd a trailing newline.
The file should end with a single newline character to satisfy markdownlint MD047.
✅ Proposed fix
---8<-- "products/general/contact-us/YouTube.md:5:" +--8<-- "products/general/contact-us/YouTube.md:5:" +docs/homey/products/temp1b/setup/getting-started-temp1.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSuppress MD041 for include-only wrapper and add trailing newline.
Markdownlint flags missing H1 and missing trailing newline. If linting is enforced, explicitly disable MD041 for this wrapper and ensure the file ends with a newline.
🔧 Suggested fix
+<!-- markdownlint-disable MD041 --> --8<-- "homey/products/general/setup/getting-started-temp1.md:5:" +docs/homey/products/general/resellers.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSuppress MD041 (wrapper include) and add trailing newline.
If markdownlint runs in CI, this wrapper-only file will fail MD041/MD047. Consider disabling MD041 for this file and ensure a final newline.
🔧 Suggested fix
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/resellers.md:5:" +docs/products/general/calibrating-and-updating/zone-configuration/zones-ha.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAddress MD041 in wrapper files (heading or lint disable).
If markdownlint is enforced, this wrapper will keep failing MD041. Consider adding an H1 wrapper title or locally disabling MD041 for this file to match the include-only pattern.
✅ Option 1: Disable MD041 for this wrapper
+<!-- markdownlint-disable MD041 --> --8<-- "products/mtr1/setup/zones-ha.md:5:"✅ Option 2: Add a wrapper H1 (if duplication is acceptable)
+# Zones (Home Assistant) --8<-- "products/mtr1/setup/zones-ha.md:5:"docs/products/temp1b/setup/getting-started-temp1.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAddress MD041 by adding a wrapper H1 or disabling the lint rule here.
The include likely brings in the H1, but markdownlint still flags the wrapper file. Consider adding a top-level heading or a file-level lint disable to keep the lint clean.
🧩 Example fix options
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/setup/getting-started-temp1.md:5:"or
+# Getting Started (TEMP-1B) --8<-- "products/general/setup/getting-started-temp1.md:5:"docs/homey/products/general/calibrating-and-updating/zone-configuration/zones-ha.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAddress markdownlint MD041/MD047 for wrapper-only file.
This file is intentionally a wrapper, but markdownlint flags missing top-level heading and trailing newline. Please either disable MD041 for this file and add a trailing newline, or add a compliant header if desired.
🧹 Suggested minimal lint fix
+<!-- markdownlint-disable MD041 --> --8<-- "homey/products/mtr1/setup/zones-ha.md:5:" +docs/products/general/calibrating-and-updating/zone-configuration/zones-hlk.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSilence MD041 for include-only wrapper.
This wrapper will always trip MD041 because the H1 is in the included file. Add a local markdownlint disable to avoid persistent lint noise.✅ Suggested fix
+<!-- markdownlint-disable MD041 --> --8<-- "products/mtr1/setup/zones-hlk.md:5:"docs/products/general/calibrating-and-updating/radar-tuning/zones-hlk.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSilence MD041 for include-only wrapper.
This wrapper will always trip MD041 because the H1 lives in the included file. Add a local markdownlint disable to avoid persistent lint noise.✅ Suggested fix
+<!-- markdownlint-disable MD041 --> --8<-- "products/msr1/calibrating-and-updating/zones-hlk.md:5:"docs/homey/products/mtr1/calibrating-co2.md-1-1 (2)
1-1:⚠️ Potential issue | 🟡 Minormarkdownlint MD047: add trailing newline.
The file should end with a single newline to satisfy MD047.
🧹 Suggested fix
--8<-- "products/general/calibrating-and-updating/co2-calibration-quick-mobile.md:5:" +
1-1:⚠️ Potential issue | 🟡 Minormarkdownlint MD041: wrapper file needs a top-level heading or disable rule.
This include-only file violates MD041. Add a minimal heading or disable the rule to keep lint clean for wrapper files.
🧩 Suggested fix (disable for this file)
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/calibrating-and-updating/co2-calibration-quick-mobile.md:5:"docs/products/msr1/calibrating-co2.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 Minormarkdownlint MD041: wrapper file needs a top-level heading or disable rule.
This include-only file violates MD041. Add a minimal heading or disable the rule to keep lint clean for wrapper files.
🧩 Suggested fix (disable for this file)
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/calibrating-and-updating/co2-calibration-quick-mobile.md:5:"docs/homey/products/plt1b/calibrating-plt1.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorMD047: Ensure the file ends with a newline.
Add a single trailing newline so markdownlint doesn’t flag MD047.
🧰 Suggested fix
--8<-- "homey/products/plt1/calibrating-plt1.md:5:" +docs/products/temp1/battery-sensors/wake-up-battery-sensor.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorMD041: Wrapper starts with include; add H1 or disable MD041.
If markdownlint is enforced, this will keep failing. Either add a top‑level heading or disable MD041 for this file.
🧰 Suggested lint suppression
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" +<!-- markdownlint-enable MD041 -->docs/homey/products/plt1b/battery-sensors/sensor-connection-check.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSilence MD041 for include-only wrapper.
Include-only wrapper triggers MD041; add a scoped markdownlint disable to keep the pattern clean.🧩 Proposed fix
+<!-- markdownlint-disable MD041 --> --8<-- "homey/products/general/battery-sensors/sensor-connection-check.md:5:" +<!-- markdownlint-enable MD041 -->docs/homey/products/plt1b/battery-sensors/wake-up-battery-sensor.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorAdd a trailing newline to satisfy MD047.
The file ends without a newline; add one to avoid lint failures.docs/homey/products/temp1b/battery-sensors/wake-up-battery-sensor.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSilence MD041 for include-only wrapper.
Include-only wrapper triggers MD041; add a scoped markdownlint disable to keep the pattern clean.🧩 Proposed fix
+<!-- markdownlint-disable MD041 --> --8<-- "homey/products/general/battery-sensors/wake-up-battery-sensor.md:5:" +<!-- markdownlint-enable MD041 -->docs/homey/products/general/contact-us/GitHub.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSuppress MD041 for wrapper-only include and add trailing newline.
This wrapper will trip markdownlint’s “first line should be H1” rule. Add MD041 suppression and ensure a trailing newline to clear MD047.
✅ Suggested tweak
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/contact-us/GitHub.md:5:" +<!-- markdownlint-enable MD041 --> +docs/homey/products/general/contact-us/Reddit.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSuppress MD041 for wrapper-only include and add trailing newline.
This wrapper will trip markdownlint’s “first line should be H1” rule. Add MD041 suppression and ensure a trailing newline to clear MD047.
✅ Suggested tweak
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/contact-us/Reddit.md:5:" +<!-- markdownlint-enable MD041 --> +docs/homey/products/general/contact-us/Instagram.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 MinorSuppress MD041 for wrapper-only include and add trailing newline.
This wrapper will trip markdownlint’s “first line should be H1” rule. Add MD041 suppression and ensure a trailing newline to clear MD047.
✅ Suggested tweak
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/contact-us/Instagram.md:5:" +<!-- markdownlint-enable MD041 --> +
🧹 Nitpick comments (4)
docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md (1)
1-1: Silence MD041 for include-only wrapper.markdownlint flags missing top-level heading; for snippet wrappers this is expected, but if lint runs in CI, it will fail. Consider disabling MD041 in this file.
Suggested change
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:"docs/homey/products/general/contact-us/Facebook.md (1)
1-1: Silence markdownlint MD041 and ensure trailing newline.Wrapper-only include files typically fail MD041 and MD047. If markdownlint is enforced, add an inline disable for MD041 and ensure the file ends with a newline.
♻️ Proposed fix (lint-only)
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/contact-us/Facebook.md:5:" +docs/homey/products/general/contact-us/our-team.md (1)
1-1: Silence markdownlint MD041 and ensure trailing newline.Wrapper-only include files typically fail MD041 and MD047. If markdownlint is enforced, add an inline disable for MD041 and ensure the file ends with a newline.
♻️ Proposed fix (lint-only)
+<!-- markdownlint-disable MD041 --> --8<-- "products/general/contact-us/general/our-team.md:5:" +docs/products/temp1b/battery-sensors/awake-ha-helper.md (1)
1-1: Implementation correctly follows the wrapper pattern.The snippet include with
:5:slice properly skips the YAML front matter from the source file, matching the pattern described in the PR objectives. The MD041 warning from markdownlint is expected for include-only wrappers and doesn't affect the MkDocs build (PR confirms 0 doc warnings).💡 Optional: Suppress MD041 project-wide if desired
If the MD041 warnings are distracting during development, consider adding a project-wide suppression in your markdownlint configuration file rather than adding per-file comments or headings (which would duplicate source content):
# .markdownlint.json or .markdownlint.yaml MD041: false # Allow files without top-level heading (for include wrappers)Or use a glob pattern to target only wrapper files if needed.
Some source files (contact-us pages, homey wrappers, msr1 zones) don't have YAML front matter, so :5: was skipping actual content. Removed :5: for those files. Also changed :5: to :7: for two files with 6-line front matter (temp1-general-tips, holiday-songs).
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/homey/products/plt1b/examples/flower-card.md`:
- Line 1: This file is a wrapper-only markdown include causing markdownlint
MD041; fix by either adding a top-level heading or disabling MD041 locally for
this wrapper: locate the include reference "--8<--
\"homey/products/plt1/examples/flower-card.md\"" and either add a suitable H1
title to the wrapper or add inline markdownlint directives to disable MD041 (and
re-enable afterward) so the linter stops flagging the single-include file.
🧹 Nitpick comments (1)
docs/homey/products/general/calibrating-and-updating/zone-configuration/zones-ha.md (1)
1-1: Silence MD041 for wrapper include files.markdownlint flags MD041 because the first line isn’t a heading. If lint is enforced, add a local disable comment (or a simple H1 if you prefer) to avoid CI noise for wrapper-only files.
🧹 Proposed lint suppression
+<!-- markdownlint-disable MD041 --> --8<-- "homey/products/mtr1/setup/zones-ha.md"
| @@ -0,0 +1 @@ | |||
| --8<-- "homey/products/plt1/examples/flower-card.md" | |||
There was a problem hiding this comment.
Address MD041 for wrapper-only markdown.
The file is a single include, so markdownlint flags missing H1. Consider disabling MD041 for this wrapper or adding a heading to satisfy lint.
✅ Suggested fix (disable MD041 locally)
+<!-- markdownlint-disable MD041 -->
--8<-- "homey/products/plt1/examples/flower-card.md"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --8<-- "homey/products/plt1/examples/flower-card.md" | |
| <!-- markdownlint-disable MD041 --> | |
| --8<-- "homey/products/plt1/examples/flower-card.md" |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
In `@docs/homey/products/plt1b/examples/flower-card.md` at line 1, This file is a
wrapper-only markdown include causing markdownlint MD041; fix by either adding a
top-level heading or disabling MD041 locally for this wrapper: locate the
include reference "--8<-- \"homey/products/plt1/examples/flower-card.md\"" and
either add a suitable H1 title to the wrapper or add inline markdownlint
directives to disable MD041 (and re-enable afterward) so the linter stops
flagging the single-include file.
1 participant
Summary
mkdocs.ymlnav sections showed the wrong sidebar (MkDocs assigns each.mdfile to only one section — last occurrence wins)--8<-- "path/to/source.md"includes so each nav entry points to a unique file path while sharing contentExample
Visiting
/products/general/calibrating-and-updating/mmwave-videos/previously showed the MSR-1 sidebar instead of the General sidebar. Now each section has its own wrapper file pointing to the canonical source.Test plan
mkdocs buildproduces 0 doc warnings🤖 Generated with Claude Code
Summary by CodeRabbit