Integration installation: rephrase procedure #482
Conversation
|
Warning Rate limit exceeded@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 44 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. WalkthroughThe updates to Changes
Sequence Diagram(s)No sequence diagrams generated as the changes are primarily content reorganizations and clarifications. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| 1. In Home Assistant, go to <!-- hacs:my info **{{coreui('panel.config')}}** > **{{coreui('ui.panel.config.dashboard.devices.main')}}** -->. | ||
| 2. Clear your browser cache. | ||
| - Before HACS can show up in the list you need to clear your browser cache or perform hard-refresh. | ||
| !!! tip | ||
| You actually need to do this, don't skip it. | ||
|
|
||
| !!! tip | ||
| You actually need to do this, don't skip it. | ||
| 3. In the bottom right corner, select **+ Add integration**. | ||
| 4. Search for **HACS** and select it. | ||
| 5. Acknowledge the statements and select **Submit**. | ||
| 6. Authenticate the integration: | ||
| - HACS uses a device OAuth flow for authentication against the GitHub API. | ||
| - Copy the device code and select the link [https://github.com/login/device](https://github.com/login/device). **Do not click on submit yet!** | ||
|
|
||
| ## Add the integration | ||
|  | ||
|
|
||
| 1. Click on the "+ Add integration" button in the bottom right corner. | ||
| 1. Search for "HACS". | ||
| 1. Then select (click on) it. | ||
| - Sign in to GitHub. | ||
| - If you are not signed in to GitHub in your browser you need to signup or sign in now to continue the setup. | ||
| - If you are already signed in, you can skip this part. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Accept usage | ||
| - Enter the device code you copied in the previous step and select **Continue**. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Only the last item (experimental features) are optional, you need to accept everything above that before you can setup HACS. | ||
| - Select **Authorize HACS**. | ||
|
|
||
| ## Device registration | ||
|  | ||
|
|
||
| HACS uses a device OAuth flow for authentication against the GitHub API. | ||
| - Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| On the first screen you are presented with a device code, copy that to your clipboard and click on the [https://github.com/login/device](https://github.com/login/device) link to continue the setup. | ||
|
|
||
| **Do not click on submit yet!** | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| If you are not signed in to GitHub in your browser you need to signup or signin now to continue the setup, if you are already signed in, you can skip this part. | ||
|
|
||
| --- | ||
|  | ||
|
|
||
|  | ||
| 7. To complete the configuration of HACS, select **Submit**. | ||
|
|
||
| When that page is loaded up, paste or type in your device code that was presented to you in the previous step. | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| Here you click on "Authorize hacs". | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | ||
|
|
||
| --- | ||
|  | ||
|
|
||
|  | ||
| 8. Assign HACS to an area and select **Finish**. | ||
|
|
||
| Now you can click "Submit" to complete the configuration of HACS. | ||
|  |
There was a problem hiding this comment.
The installation steps are clear and well-documented. The use of images enhances user understanding. However, consider adding alt text to images for accessibility.
Tools
LanguageTool
[uncategorized] ~18-~18: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...e. - Before HACS can show up in the list you need to clear your browser cache or...
[uncategorized] ~18-~18: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ... to clear your browser cache or perform hard-refresh. !!! tip You actual...
[uncategorized] ~22-~22: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...d to do this, don't skip it. 3. In the bottom right corner, select + Add integration. 4...
[style] ~27-~27: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1553 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...in/device). Do not click on submit yet! 
Context: ...you are not signed in to GitHub in your browser you need to signup or sign in now to co...
[grammar] ~32-~32: The word “signup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...n to GitHub in your browser you need to signup or sign in now to continue the setup. ...
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range comments (1)
source/docs/use/configuration/basic.md (1)
Line range hint
62-62: The repeated phrasing "you need to" could be varied to improve the readability of the document.- If you need to change the configuration, you first need to delete the integration from the integrations list, then you need to add it back again. + To change the configuration, first delete the integration from the integrations list, then add it back.Tools
LanguageTool
[uncategorized] ~22-~22: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...d to do this, don't skip it. 3. In the bottom right corner, select + Add integration. 4...
[style] ~27-~27: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1556 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...ogin/device). Do not select Submit yet! 
Multiple consecutive blank lines
59-59: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
| 1. In Home Assistant, go to <!-- hacs:my info **{{coreui('panel.config')}}** > **{{coreui('ui.panel.config.dashboard.devices.main')}}** -->. | ||
| 2. Clear your browser cache. | ||
| - Before HACS can show up in the list, you need to clear your browser cache or perform a hard-refresh. | ||
| !!! tip | ||
| You actually need to do this, don't skip it. | ||
|
|
||
| !!! tip | ||
| You actually need to do this, don't skip it. | ||
| 3. In the bottom right corner, select **+ Add integration**. | ||
| 4. Search for **HACS** and select it. | ||
| 5. Acknowledge the statements and select **Submit**. | ||
| 6. Authenticate the integration: | ||
| - HACS uses a device OAuth flow for authentication against the GitHub API. | ||
| - Copy the device code and select the link [https://github.com/login/device](https://github.com/login/device). **Do not select Submit yet!** | ||
|
|
||
| ## Add the integration | ||
|  | ||
|
|
||
| 1. Click on the "+ Add integration" button in the bottom right corner. | ||
| 1. Search for "HACS". | ||
| 1. Then select (click on) it. | ||
| - Sign in to GitHub. | ||
| - If you are not signed in to GitHub in your browser, you need to sign up or sign in now to continue the setup. | ||
| - If you are already signed in, you can skip this part. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Accept usage | ||
| - Enter the device code you copied in the previous step and select **Continue**. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Only the last item (experimental features) are optional, you need to accept everything above that before you can setup HACS. | ||
| - Select **Authorize HACS**. | ||
|
|
||
| ## Device registration | ||
|  | ||
|
|
||
| HACS uses a device OAuth flow for authentication against the GitHub API. | ||
| - Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| On the first screen you are presented with a device code, copy that to your clipboard and click on the [https://github.com/login/device](https://github.com/login/device) link to continue the setup. | ||
|
|
||
| **Do not click on submit yet!** | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| If you are not signed in to GitHub in your browser you need to signup or signin now to continue the setup, if you are already signed in, you can skip this part. | ||
|
|
||
| --- | ||
|  | ||
|
|
||
|  | ||
| 7. To complete the configuration of HACS, select **Submit**. | ||
|
|
||
| When that page is loaded up, paste or type in your device code that was presented to you in the previous step. | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| Here you click on "Authorize hacs". | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | ||
|
|
||
| --- | ||
|  | ||
|
|
||
|  | ||
| 8. Assign HACS to an area and select **Finish**. | ||
|
|
||
| Now you can click "Submit" to complete the configuration of HACS. | ||
|  |
There was a problem hiding this comment.
The step-by-step installation instructions are clear and detailed. However, consider adding alternative text to images for accessibility and SEO purposes.
- 
+ 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.
| 1. In Home Assistant, go to <!-- hacs:my info **{{coreui('panel.config')}}** > **{{coreui('ui.panel.config.dashboard.devices.main')}}** -->. | |
| 2. Clear your browser cache. | |
| - Before HACS can show up in the list, you need to clear your browser cache or perform a hard-refresh. | |
| !!! tip | |
| You actually need to do this, don't skip it. | |
| !!! tip | |
| You actually need to do this, don't skip it. | |
| 3. In the bottom right corner, select **+ Add integration**. | |
| 4. Search for **HACS** and select it. | |
| 5. Acknowledge the statements and select **Submit**. | |
| 6. Authenticate the integration: | |
| - HACS uses a device OAuth flow for authentication against the GitHub API. | |
| - Copy the device code and select the link [https://github.com/login/device](https://github.com/login/device). **Do not select Submit yet!** | |
| ## Add the integration | |
|  | |
| 1. Click on the "+ Add integration" button in the bottom right corner. | |
| 1. Search for "HACS". | |
| 1. Then select (click on) it. | |
| - Sign in to GitHub. | |
| - If you are not signed in to GitHub in your browser, you need to sign up or sign in now to continue the setup. | |
| - If you are already signed in, you can skip this part. | |
|  | |
|  | |
| ## Accept usage | |
| - Enter the device code you copied in the previous step and select **Continue**. | |
|  | |
|  | |
| Only the last item (experimental features) are optional, you need to accept everything above that before you can setup HACS. | |
| - Select **Authorize HACS**. | |
| ## Device registration | |
|  | |
| HACS uses a device OAuth flow for authentication against the GitHub API. | |
| - Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | |
| --- | |
|  | |
| On the first screen you are presented with a device code, copy that to your clipboard and click on the [https://github.com/login/device](https://github.com/login/device) link to continue the setup. | |
| **Do not click on submit yet!** | |
| --- | |
|  | |
| If you are not signed in to GitHub in your browser you need to signup or signin now to continue the setup, if you are already signed in, you can skip this part. | |
| --- | |
|  | |
|  | |
| 7. To complete the configuration of HACS, select **Submit**. | |
| When that page is loaded up, paste or type in your device code that was presented to you in the previous step. | |
| --- | |
|  | |
| Here you click on "Authorize hacs". | |
| --- | |
|  | |
| Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | |
| --- | |
|  | |
|  | |
| 8. Assign HACS to an area and select **Finish**. | |
| Now you can click "Submit" to complete the configuration of HACS. | |
|  | |
| 1. In Home Assistant, go to <!-- hacs:my info **{{coreui('panel.config')}}** > **{{coreui('ui.panel.config.dashboard.devices.main')}}** -->. | |
| 2. Clear your browser cache. | |
| - Before HACS can show up in the list, you need to clear your browser cache or perform a hard-refresh. | |
| !!! tip | |
| You actually need to do this, don't skip it. | |
| 3. In the bottom right corner, select **+ Add integration**. | |
| 4. Search for **HACS** and select it. | |
| 5. Acknowledge the statements and select **Submit**. | |
| 6. Authenticate the integration: | |
| - HACS uses a device OAuth flow for authentication against the GitHub API. | |
| - Copy the device code and select the link [https://github.com/login/device](https://github.com/login/device). **Do not select Submit yet!** | |
|  | |
| - Sign in to GitHub. | |
| - If you are not signed in to GitHub in your browser, you need to sign up or sign in now to continue the setup. | |
| - If you are already signed in, you can skip this part. | |
|  | |
| - Enter the device code you copied in the previous step and select **Continue**. | |
|  | |
| - Select **Authorize HACS**. | |
|  | |
| - Once you see the confirmation screen, you can close the tab and go back to Home Assistant. | |
|  | |
| 7. To complete the configuration of HACS, select **Submit**. | |
|  | |
| 8. Assign HACS to an area and select **Finish**. | |
|  |
Tools
LanguageTool
[uncategorized] ~22-~22: Consider adding a hyphen. (TOP_LEFT_CORNER)
Context: ...d to do this, don't skip it. 3. In the bottom right corner, select + Add integration. 4...
[style] ~27-~27: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 1556 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...ogin/device). Do not select Submit yet! 
c0ffeeca7
changed the title
c0ffeeca7
force-pushed
the
integration-install-update
branch
from
4c85961
to
44e29a1
Compare
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Remove extra blank lines to adhere to Markdown best practices.
- According to Markdownlint rule MD012, multiple consecutive blank lines should be avoided to maintain a clean and professional appearance in Markdown files.
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.
Tools
Markdownlint
56-56: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
| 1. In Home Assistant, go to <!-- hacs:my integrations **{{coreui('panel.config')}}** > **{{coreui('ui.panel.config.dashboard.devices.main')}}** -->. | ||
| 2. Clear your browser cache. | ||
| - Before HACS can show up in the list, you need to clear your browser cache or perform a hard-refresh. | ||
| !!! tip |
There was a problem hiding this comment.
Consider reducing the number of exclamation marks for a more professional tone.
- !!! tip
- You actually need to do this, don't skip it.
+ !!! tip
+ It's important to do this, please do not skip.Excessive use of exclamation marks can be perceived as unprofessional in documentation. The suggested change maintains the emphasis on not skipping the step while toning down the expression.
Committable suggestion was skipped due to low confidence.
Tools
LanguageTool
[style] ~20-~20: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1392 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...er cache or perform a hard-refresh. !!! tip You actually need to do thi...
| 1. Search for "HACS". | ||
| 1. Then select (click on) it. | ||
| - Sign in to GitHub. | ||
| - If you are not signed in to GitHub in your browser, you need to sign up or sign in now to continue the setup. |
There was a problem hiding this comment.
Improve the grammatical structure of the sign-in instruction.
- If you are not signed in to GitHub in your browser, you need to sign up or sign in now to continue the setup.
+ If you are not signed in to GitHub in your browser, you must sign up or sign in to continue the setup.The repeated phrase "you need to" can be simplified to "you must" for better readability and to avoid redundancy.
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.
| - If you are not signed in to GitHub in your browser, you need to sign up or sign in now to continue the setup. | |
| - If you are not signed in to GitHub in your browser, you must sign up or sign in to continue the setup. |
Tools
LanguageTool
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB)
Context: ...igned in to GitHub in your browser, you need to sign up or sign in now to continue the ...
Co-authored-by: Joakim Sørensen <[email protected]>
No description provided.