Split settings #187
Split settings #187
Conversation
|
Warning Rate limit exceeded@DTTerastar has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 18 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 (2)
WalkthroughThe pull request introduces a new markdown file 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 using PR comments)
Other keywords and placeholders
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: 4
🧹 Nitpick comments (3)
configuration/initial-settings.md (2)
11-11: Enhance clarity of the introduction.Consider clarifying what constitutes a "normal boot" and how users can access these settings later if they need to modify them.
-The ESP32 will launch a captive browser (under its own SSID) on first normal boot after flashing that will allow you to configure initial settings. +The ESP32 will launch a captive browser (under its own SSID) when first powered on after flashing. This allows you to configure initial settings. These settings can also be accessed later through the device's web interface at http://<device-ip>.
20-20: Fix grammar and enhance room name explanation.The sentence has a grammar error and could be clearer about the slugification process.
-* Room name - This is the name that will identify this sensor in Home Assistant, as well as the state of mqtt_room sensor. Use a upper/lower word and we'll slugify it for the places that need that +* Room name - This is the name that will identify this sensor in Home Assistant, as well as the state of mqtt_room sensor. Use an upper/lowercase word (e.g., "LivingRoom") and we'll automatically convert it to a valid format (e.g., "living_room") where needed🧰 Tools
🪛 LanguageTool
[misspelling] ~20-~20: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...l as the state of mqtt_room sensor. Use a upper/lower word and we'll slugify it f...(EN_A_VS_AN)
[uncategorized] ~20-~20: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...mqtt_room sensor. Use a upper/lower word and we'll slugify it for the places that ne...(COMMA_COMPOUND_SENTENCE)
configuration/settings.md (1)
21-21: Improve clarity and grammar in Query explanation.The explanation of the Query feature needs better structure and punctuation.
-* Query - we use the best id we can figure out based on passively listening to device advertisements, but sometimes you want an even better id. Query enables the ESP to connect to the device and ask it questions. Currently we ask for the room assistant id, model, and name. If we get useful answers back we will upgrade the id to the most selective one. +* Query - While we determine the best possible ID by passively listening to device advertisements, sometimes a more precise identification is needed. When Query is enabled, the ESP will connect to the device and request additional information. Currently, we ask for the room assistant ID, model, and name. If useful responses are received, we'll upgrade the device ID to use the most distinctive information available.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...ect to the device and ask it questions. Currently we ask for the room assistant id, model...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
images/full_settings.pngis excluded by!**/*.pngimages/settings_screenshot.pngis excluded by!**/*.png
📒 Files selected for processing (3)
configuration/home_assistant.md(1 hunks)configuration/initial-settings.md(1 hunks)configuration/settings.md(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- configuration/home_assistant.md
🧰 Additional context used
🪛 LanguageTool
configuration/initial-settings.md
[misspelling] ~20-~20: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...l as the state of mqtt_room sensor. Use a upper/lower word and we'll slugify it f...
(EN_A_VS_AN)
[uncategorized] ~20-~20: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...mqtt_room sensor. Use a upper/lower word and we'll slugify it for the places that ne...
(COMMA_COMPOUND_SENTENCE)
[style] ~28-~28: The word ‘kinda’ is informal. Consider replacing it.
Context: ...me / Password - optional, passwords are kinda pointless when you're using them plaint...
(KINDA)
configuration/settings.md
[uncategorized] ~20-~20: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ac periodically you can just put it here and we'll use the id known:{mac} * Query ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~21-~21: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...ect to the device and ask it questions. Currently we ask for the room assistant id, model...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~42-~42: Possible missing comma found.
Context: ...ot seen for this amount of time. If too low we'll delete and re-add too often. Not ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~42-~42: Who is ‘not sure’? Consider being more precise.
Context: ... low we'll delete and re-add too often. Not sure why this is even configurable. ## Misc...
(WHO_NOT_SURE)
🪛 Markdownlint (0.37.0)
configuration/initial-settings.md
15-15: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
configuration/settings.md
15-15: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit
initial-settings.mddocument with detailed ESP32 device configuration instructions