Update DOCS.md, use ens #146
#167
Conversation
WalkthroughThe pull request focuses on improving the documentation for the eBUSd Home Assistant add-on. The changes involve refining the documentation's clarity, formatting, and accuracy. Key modifications include updating configuration instructions, adding a hyperlink to the eBUSd Wiki, standardizing code snippet formatting, and correcting a spelling error in a network device example. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (7)
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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
ebusd/DOCS.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
ebusd/DOCS.md
[typographical] ~36-~36: It seems that a comma is missing.
Context: ...r MQTT cfg files: To use custom config files you can use the configpath option. Yo...
(IN_ORDER_TO_VB_COMMA)
[typographical] ~70-~70: After the expression ‘for example’ a comma is usually used.
Context: ...ithub.com/john30/ebusd/wiki/2.-Run For example --initsend --dumpconfig ## Network ...
(COMMA_FOR_EXAMPLE)
[grammar] ~74-~74: The verb form ‘has’ does not seem to match the subject ‘options’.
Context: ...dex.en.html). The configuration options has changed from custom_device to network_d...
(SUBJECT_VERB_AGREEMENT_PLURAL)
[typographical] ~76-~76: After the expression ‘for example’ a comma is usually used.
Context: ...m custom_device to network_device. For example network_device: ens:Y.Y.Y.Y:9999 Wher...
(COMMA_FOR_EXAMPLE)
🪛 Markdownlint (0.37.0)
ebusd/DOCS.md
34-34: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
36-36: null
Bare URL used
(MD034, no-bare-urls)
49-49: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
70-70: null
Spaces inside code span elements
(MD038, no-space-in-code)
🔇 Additional comments (3)
ebusd/DOCS.md (3)
11-11: Great addition of the configuration entries link!The hyperlink to the device options documentation improves the user experience by providing direct access to detailed configuration information.
29-32: Excellent addition of practical MQTT tips!The added tips provide valuable guidance for:
- Setting up automatic polling
- Configuring the heating system
- Debugging MQTT issues
38-38: LGTM!Clear and consistent instructions for MQTT configuration file setup.
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
ebusd/DOCS.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
ebusd/DOCS.md
[uncategorized] ~31-~31: A comma might be missing here.
Context: ...ly. - Once your heating system has been detected change the device name from "ebusd bai"...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~31-~31: A comma might be missing here.
Context: ...me from "ebusd bai" to the name of your boiler e.g. "ecoTEC pro" - If some polled read...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~32-~32: A comma might be missing here.
Context: ... polled readings do not show up in Home Assistant it might be because mqtt-hassio.cfg is ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~38-~38: You might be missing the article “the” here.
Context: ...larly for MQTT, create a config file in "/config" folder and link it using the `-...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~73-~73: The verb form ‘has’ does not seem to match the subject ‘options’.
Context: ...dex.en.html). The configuration options has changed from custom_device to network_d...
(SUBJECT_VERB_AGREEMENT_PLURAL)
🪛 Markdownlint (0.37.0)
ebusd/DOCS.md
34-34: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
36-36: null
Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (4)
ebusd/DOCS.md (4)
11-11: LGTM! Documentation improvement.Good addition of the hyperlink to configuration entries and clear device configuration examples.
36-36: LGTM! Implemented previous suggestion.Good implementation of the previously suggested comma addition after "To use custom config files".
🧰 Tools
🪛 Markdownlint (0.37.0)
36-36: null
Bare URL used(MD034, no-bare-urls)
47-49: LGTM! Implemented previous formatting suggestion.Good implementation of the previously suggested removal of extra blank lines.
69-69: LGTM! Implemented previous formatting suggestions.Good implementation of the previously suggested comma addition and code span formatting fixes.
|
Great contribution, Thank you! can you please rebase to the rc-24.1.2 branch? |
cociweb
added
documentation
closes #146
Summary by CodeRabbit