Installation methods: fix order #39714
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the installation instructions to fix the order of the installation methods and improve the layout of the deprecated and recommended sections.
- Reorders the installation methods content, introducing a new section for recommended methods
- Adds a comparison table for installation features
- Relocates and refines the deprecated installation methods section
|
Warning Rate limit exceeded@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 6 seconds before requesting another review. ⌛ 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. 📒 Files selected for processing (1)
📝 Walkthrough""" WalkthroughThe changes restructure the installation documentation page by consolidating duplicated sections about Home Assistant installation methods and relocating the deprecated methods section. Content remains unchanged, but explanatory sections and comparison tables are moved to improve document flow and eliminate redundancy. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to HTML content restructuring without modifications to control flow or feature logic. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/installation/index.html(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| <sub | ||
| >1: Names are abbreviated. The full names of the installation methods are: | ||
| <ul> | ||
| <li style="margin-top: 0.4em">Home Assistant Operating System</li> | ||
| <li style="margin-top: 15px">Home Assistant Container</li> | ||
| </ul></sub | ||
| > |
There was a problem hiding this comment.
<sub> contains a <ul> – violates HTML content model
<sub> is an inline element that may only contain phrasing content; embedding a block-level <ul> is invalid and may lead to unpredictable rendering.
- <sub
- >1: Names are abbreviated. The full names of the installation methods are:
- <ul>
- <li style="margin-top: 0.4em">Home Assistant Operating System</li>
- <li style="margin-top: 15px">Home Assistant Container</li>
- </ul></sub
- >
+ <small class="footnote">
+ 1: Names are abbreviated. The full names of the installation methods are:
+ <ul>
+ <li>Home Assistant Operating System</li>
+ <li>Home Assistant Container</li>
+ </ul>
+ </small>Switching to <small> (or a <div> with a class) preserves styling while keeping the document valid.
📝 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.
| <sub | |
| >1: Names are abbreviated. The full names of the installation methods are: | |
| <ul> | |
| <li style="margin-top: 0.4em">Home Assistant Operating System</li> | |
| <li style="margin-top: 15px">Home Assistant Container</li> | |
| </ul></sub | |
| > | |
| <small class="footnote"> | |
| 1: Names are abbreviated. The full names of the installation methods are: | |
| <ul> | |
| <li>Home Assistant Operating System</li> | |
| <li>Home Assistant Container</li> | |
| </ul> | |
| </small> |
🤖 Prompt for AI Agents
In source/installation/index.html around lines 77 to 83, the <sub> element
incorrectly contains a block-level <ul>, which violates HTML content rules.
Replace the <sub> tag with a <small> tag or a <div> with an appropriate class to
maintain styling while ensuring the HTML structure is valid and only contains
phrasing content inside inline elements.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
source/installation/index.html (1)
78-84:<sub>still contains a block-level<ul>– violates HTML spec
Same issue called out in the previous review: inline elements may not wrap block elements. Please switch to<small>(or a styled<div>) as already suggested.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/installation/index.html(2 hunks)
🧰 Additional context used
🪛 HTMLHint (1.5.0)
source/installation/index.html
[error] 42-42: Tag must be paired, no start tag: [ ]
(tag-pair)
[error] 523-523: Tag must be paired, missing: [
], open tag match failed [] on line 85.
(tag-pair)
| <li style="margin-top: 15px">Home Assistant Container</li> | ||
| </ul></sub | ||
| > | ||
| <p> |
There was a problem hiding this comment.
Unmatched <p> tags – remove stray opener/closer
Line 85 opens a paragraph that is implicitly closed by the following <div>, leaving the closing <p></p> at 523 unmatched. Delete both to restore well-formed markup.
- <p>
…
- <p></p>Also applies to: 523-523
🤖 Prompt for AI Agents
In source/installation/index.html at lines 85 and 523, there are unmatched <p>
tags causing invalid HTML structure. Remove the stray opening <p> tag at line 85
and the corresponding closing </p> tag at line 523 to ensure all paragraph tags
are properly matched and the markup is well-formed.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Proposed change
Move About installation methods to top,
Move Deprecated installation methods to bottom of page
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit