Updating DOCs Install md #213
Conversation
Signed-off-by: [email protected] <[email protected]>
|
Warning Rate limit exceeded@sca075 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 57 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 documentation for the MQTT Vacuum Camera integration has been refined to provide clearer installation guidelines. A new section for installation via HACS has been introduced, and the component's naming convention has been updated for consistency. The document's overall structure has been enhanced for better readability, ensuring a smooth user experience during the integration process with Home Assistant. Changes
Poem
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 Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
Outside diff range, codebase verification and nitpick comments (1)
docs/install.md (1)
6-7: Ensure consistency and clarity in instructions.The instruction "If you click this button below we can go to step #2" should be rephrased for better clarity.
- ## If you click this button below we can go to step #2 + ## Click the button below to proceed to Step 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/install.md (3 hunks)
Additional context used
Markdownlint
docs/install.md
9-9: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
29-29: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
44-44: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
49-49: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
20-20: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
20-20: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
LanguageTool
docs/install.md
[grammar] ~24-~24: The word “setup” is a noun. The verb is spelled with a space.
Context: ...gration, HACS will setup the integration for you. (Note: You can...(NOUN_VERB_CONFUSION)
[grammar] ~24-~24: The past participle is required after “to be”.
Context: ...e: You can selct here if you want to be notify for beta releases that some time are co...(BE_VBP_IN)
[grammar] ~35-~35: Consider using either the past participle “connected” or the present participle “connecting” here.
Context: ...be done via Options. The camera will is connect automatically to the HA MQTT (whatever ...(BEEN_PART_AGREEMENT)
[typographical] ~40-~40: After the expression ‘for example’ a comma is usually used.
Context: ...r vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. ...(COMMA_FOR_EXAMPLE)
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...ra at the end. To configure the Camera Options use Home Assistant "Settings" -> "Devic...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (2)
docs/install.md (2)
99-103: LGTM!The instructions and links are clear and correct.
4-4: Remove trailing punctuation in heading.The heading "Via HACS" should not have trailing punctuation.
- ## Via HACS. + ## Via HACSLikely invalid or redundant comment.
docs/install.md
Outdated
| ``` | ||
| mkdir -p custom_components/valetudo_vacuum_camera | ||
| cd custom_components/valetudo_vacuum_camera | ||
| wget https://github.com/sca075/valetudo_vacuum_camera/archive/refs/tags/v.1.5.9.zip | ||
| unzip valetudo_vacuum_camera_v1.5.9.zip | ||
| rm valetudo_vacuum_camera_v1.5.9.zip | ||
| mkdir -p custom_components/mqtt_vacuum_camera | ||
| cd custom_components/mqtt_vacuum_camera | ||
| wget https://github.com/sca075/mqtt_vacuum_camera/archive/refs/tags/v.1.5.9.zip | ||
| unzip mqtt_vacuum_camera_v1.5.9.zip | ||
| rm mqtt_vacuum_camera_v1.5.9.zip |
There was a problem hiding this comment.
Specify language for the code block.
The code block should specify the language for better readability.
- ```
+ ```shellTools
Markdownlint
49-49: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
| ## If you click this button below we can go to step #2 | ||
| [](https://my.home-assistant.io/redirect/hacs_repository/?owner=sca075&repository=mqtt_vacuum_camera&category=integration) | ||
|
|
||
| ## Step 1 Download the Component. |
There was a problem hiding this comment.
Remove trailing punctuation in heading.
The heading "Step 1 Download the Component." should not have trailing punctuation.
- ## Step 1 Download the Component.
+ ## Step 1 Download the ComponentCommittable 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.
| ## Step 1 Download the Component. | |
| ## Step 1 Download the Component |
Tools
Markdownlint
9-9: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/install.md
Outdated
|
|
||
|
|
||
| The camera entity created will have the same friendly name of your vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. | ||
| The camera entity created will have the same friendly name of your **vacuum** + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. | ||
|
|
||
|  | ||
|
|
||
| ### Manual Setup. |
There was a problem hiding this comment.
Remove trailing punctuation in heading.
The heading "Manual Setup." should not have trailing punctuation.
- ## Manual Setup.
+ ## Manual SetupCommittable 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.
| ### Manual Setup. | |
| ### Manual Setup |
Tools
Markdownlint
44-44: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
| @@ -83,13 +92,12 @@ | |||
| Assistant UI. | |||
| The camera entity created will have the same friendly name of YOUR_VACUUM_camera at the end. | |||
|
|
|||
| To configure the Camera Options use Home Assistant "Settings" -> "Devices & Services" -> "Valetudo Vacuum Camera" in | |||
| To configure the Camera Options use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in | |||
There was a problem hiding this comment.
Add comma for better readability.
There is a possible missing comma in the instructions.
- To configure the Camera Options use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in the "Integration" tab.
+ To configure the Camera Options, use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in the "Integration" tab.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.
| To configure the Camera Options use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in | |
| To configure the Camera Options, use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in the "Integration" tab. |
Tools
LanguageTool
[uncategorized] ~95-~95: Possible missing comma found.
Context: ...ra at the end. To configure the Camera Options use Home Assistant "Settings" -> "Devic...(AI_HYDRA_LEO_MISSING_COMMA)
docs/install.md
Outdated
|
|
||
|
|
||
| The camera entity created will have the same friendly name of your vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. | ||
| The camera entity created will have the same friendly name of your **vacuum** + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. |
There was a problem hiding this comment.
Add comma after "For example".
The phrase "For example vacuum.robot1" should have a comma after "For example".
- For example vacuum.robot1 = camera.robot1_camera.
+ For example, vacuum.robot1 = camera.robot1_camera.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.
| The camera entity created will have the same friendly name of your **vacuum** + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. | |
| The camera entity created will have the same friendly name of your **vacuum** + "camera" at the end. For example, vacuum.robot1 = camera.robot1_camera. |
Tools
LanguageTool
[typographical] ~40-~40: After the expression ‘for example’ a comma is usually used.
Context: ...r vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. ...(COMMA_FOR_EXAMPLE)
docs/install.md
Outdated
|
|
||
| Once the repository is added, please click on the repository and the home page will be display. From there you need to | ||
| **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). |
There was a problem hiding this comment.
Correct grammatical issues and typo.
There are grammatical issues and a typo in the instructions.
- Once the repository is added, please click on the repository and the home page will be display. From there you need to
- **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes).
+ Once the repository is added, please click on the repository and the home page will be displayed. From there you need to
+ **Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).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.
| Once the repository is added, please click on the repository and the home page will be display. From there you need to | |
| **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). | |
| Once the repository is added, please click on the repository and the home page will be displayed. From there you need to | |
| **Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes). |
Tools
LanguageTool
[grammar] ~24-~24: The word “setup” is a noun. The verb is spelled with a space.
Context: ...gration, HACS will setup the integration for you. (Note: You can...(NOUN_VERB_CONFUSION)
[grammar] ~24-~24: The past participle is required after “to be”.
Context: ...e: You can selct here if you want to be notify for beta releases that some time are co...(BE_VBP_IN)
docs/install.md
Outdated
| ## Step 2 Restart HA and Setup the component. | ||
| **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. |
There was a problem hiding this comment.
Remove trailing punctuation in heading.
The heading "Step 2 Restart HA and Setup the component." should not have trailing punctuation.
- ## Step 2 Restart HA and Setup the component.
+ ## Step 2 Restart HA and Setup the componentCommittable 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.
| ## Step 2 Restart HA and Setup the component. | |
| **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. | |
| ## Step 2 Restart HA and Setup the component | |
| **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. |
Tools
Markdownlint
29-29: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
docs/install.md
Outdated
|
|
||
| Select **Integration** as _Category_ and click the **Add** button. | ||
|
|
||
|
|
||
| Once the repository is added, please click on the repository and the home page will be display. From there you need to | ||
| **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). |
There was a problem hiding this comment.
Correct grammatical issues and typo.
There are grammatical issues and a typo in the instructions.
- Once the repository is added, please click on the repository and the home page will be display. From there you need to
- **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes).
+ Once the repository is added, please click on the repository and the home page will be displayed. From there you need to
+ **Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).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.
| **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). | |
| **Download** the integration, [HACS](https://hacs.xyz/) will set up the integration for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes). |
Tools
LanguageTool
[grammar] ~24-~24: The word “setup” is a noun. The verb is spelled with a space.
Context: ...gration, HACS will setup the integration for you. (Note: You can...(NOUN_VERB_CONFUSION)
[grammar] ~24-~24: The past participle is required after “to be”.
Context: ...e: You can selct here if you want to be notify for beta releases that some time are co...(BE_VBP_IN)
docs/install.md
Outdated
| **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. | ||
| The setup will start, you just select here the vacuum and the camera will be configured. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will is connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration. |
There was a problem hiding this comment.
Correct grammatical issue.
There is a grammatical issue with the phrase "will is connect".
- The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will is connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration.
+ The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration.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.
| **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. | |
| The setup will start, you just select here the vacuum and the camera will be configured. | |
|  | |
|  | |
| The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will is connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration. | |
| **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. | |
| The setup will start, you just select here the vacuum and the camera will be configured. | |
|  | |
| The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration. |
Tools
LanguageTool
[grammar] ~35-~35: Consider using either the past participle “connected” or the present participle “connecting” here.
Context: ...be done via Options. The camera will is connect automatically to the HA MQTT (whatever ...(BEEN_PART_AGREEMENT)
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (10)
docs/install.md (10)
8-8: Remove trailing punctuation in heading.The heading "Step 1 Download the Component." should not have trailing punctuation.
- ## Step 1 Download the Component. + ## Step 1 Download the ComponentTools
Markdownlint
8-8: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
30-31: Remove trailing punctuation in heading and improve readability.The heading "Step 2 Restart HA to finalize the component installation." should not have trailing punctuation. The instructions can be improved for readability.
- ## Step 2 Restart HA to finalize the component installation. + ## Step 2 Restart HA to finalize the component installation - **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant will reload, please go in (plase press CTRL clicking the link this would open the link in a different tab of your browser) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) then please confirm to add the integration. + **You will need to restart Home Assistant at this point** to have the integration available. Once Home Assistant reloads, please go to (please press CTRL while clicking the link to open it in a new tab) [**Settings** -> **Devices & Services**](https://my.home-assistant.io/redirect/config_flow_start/?domain=mqtt_vacuum_camera) and confirm to add the integration.Tools
Markdownlint
30-30: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
36-36: Improve readability.The instructions can be improved for readability.
- The configuration of the colours you would prefer for each element in the maps can be done via Options. The camera will connect automatically to the HA MQTT (whatever setup you use), for each vacuum you configured a new entity will be added to the configuration. + The configuration of the colors you prefer for each element in the maps can be done via Options. The camera will automatically connect to the HA MQTT (regardless of the setup you use). For each vacuum you configure, a new entity will be added to the configuration.
41-41: Add comma after "For example".The phrase "For example vacuum.robot1" should have a comma after "For example".
- For example vacuum.robot1 = camera.robot1_camera. + For example, vacuum.robot1 = camera.robot1_camera.Tools
LanguageTool
[typographical] ~41-~41: After the expression ‘for example’ a comma is usually used.
Context: ...r vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. ...(COMMA_FOR_EXAMPLE)
45-45: Remove trailing punctuation in heading.The heading "Manual Setup:" should not have trailing punctuation.
- ### Manual Setup: + ### Manual SetupTools
Markdownlint
45-45: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
48-55: Specify language for the code block.The code block should specify the language for better readability.
- ``` + ```shellTools
Markdownlint
50-50: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
76-77: Improve readability.The note can be improved for readability.
- ***Note: "YOUR_TOPIC_HERE" must be replaced with what you can find it in the camera attributes. The value is Case - Sensitive.*** + ***Note: "YOUR_TOPIC_HERE" must be replaced with the value found in the camera attributes. The value is case sensitive.***
96-96: Add comma for better readability.There is a possible missing comma in the instructions.
- To configure the Camera Options use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in the "Integration" tab. + To configure the Camera Options, use Home Assistant "Settings" -> "Devices & Services" -> "MQTT Vacuum Camera" in the "Integration" tab.
105-106: Improve readability.The instructions can be improved for readability.
- We filter the logs of HA. Only the Camera only entries on the logs are important to us, so we can help you better. - The logs are stored in the .storage folder of Home Assistant. Can be export to WWW from the options of the camera. + We filter the logs of HA. Only the Camera entries in the logs are important to us, so we can help you better. + The logs are stored in the .storage folder of Home Assistant. They can be exported to WWW from the camera options.Tools
LanguageTool
[style] ~105-~105: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... filter the logs of HA. Only the Camera only entries on the logs are important to us...(ADVERB_REPETITION_PREMIUM)
[style] ~106-~106: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ... the .storage folder of Home Assistant. Can be export to WWW from the options of th...(MISSING_IT_THERE)
108-108: Remove trailing punctuation in heading.The heading "What is in zip logs:" should not have trailing punctuation.
- ## What is in zip logs: + ## What is in zip logsTools
Markdownlint
108-108: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/install.md (4 hunks)
Additional context used
Markdownlint
docs/install.md
8-8: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
30-30: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
45-45: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
50-50: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
21-21: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
21-21: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
108-108: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
LanguageTool
docs/install.md
[grammar] ~25-~25: Did you mean “contained” or “containing”?
Context: ...ed for beta releases that some time are contain instant fixes). ![Screenshot 2024-07-1...(BE_VB_OR_NN)
[typographical] ~41-~41: After the expression ‘for example’ a comma is usually used.
Context: ...r vacuum + "camera" at the end. For example vacuum.robot1 = camera.robot1_camera. ...(COMMA_FOR_EXAMPLE)
[style] ~105-~105: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... filter the logs of HA. Only the Camera only entries on the logs are important to us...(ADVERB_REPETITION_PREMIUM)
[style] ~106-~106: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ... the .storage folder of Home Assistant. Can be export to WWW from the options of th...(MISSING_IT_THERE)
Additional comments not posted (1)
docs/install.md (1)
2-7: LGTM! Clear and concise HACS installation section.The new section provides a straightforward method for installing the component via HACS, enhancing user accessibility.
docs/install.md
Outdated
|
|
||
| Once the repository is added, please click on the repository and the home page will be display. From there you need to | ||
| **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). | ||
| **Download** the integration with [HACS](https://hacs.xyz/) that will install it for you. (Note: You can select here if you want to be notified for beta releases that some time are contain instant fixes). |
There was a problem hiding this comment.
Correct grammatical issues and improve readability.
There are grammatical issues and missing commas in the instructions.
- Once the repository is added, please click on the repository and the home page will be display. From there you need to
- **Download** the integration with [HACS](https://hacs.xyz/) that will install it for you. (Note: You can select here if you want to be notified for beta releases that some time are contain instant fixes).
+ Once the repository is added, please click on the repository and the home page will be displayed. From there, you need to
+ **Download** the integration with [HACS](https://hacs.xyz/), which will install it for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes).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.
| Once the repository is added, please click on the repository and the home page will be display. From there you need to | |
| **Download** the integration, [HACS](https://hacs.xyz/) will setup the integration for you. (Note: You can selct here if you want to be notify for beta releases that some time are containg instant fixes). | |
| **Download** the integration with [HACS](https://hacs.xyz/) that will install it for you. (Note: You can select here if you want to be notified for beta releases that some time are contain instant fixes). | |
| Once the repository is added, please click on the repository and the home page will be displayed. From there, you need to | |
| **Download** the integration with [HACS](https://hacs.xyz/), which will install it for you. (Note: You can select here if you want to be notified for beta releases that sometimes contain instant fixes). |
Tools
LanguageTool
[grammar] ~25-~25: Did you mean “contained” or “containing”?
Context: ...ed for beta releases that some time are contain instant fixes). ![Screenshot 2024-07-1...(BE_VB_OR_NN)
Signed-off-by: [email protected] <[email protected]>
The Install doccumentation is now updated to follow the mqtt vacuum camera paths, thanks @derekkddj for pointing out the improper links in this doc.
Summary by CodeRabbit
New Features
Documentation