Documentation: Add summary of what this add-on does and doesn't do #314
Conversation
WalkthroughThe documentation for the WireGuard Home Assistant add-on has been updated to enhance clarity and provide additional information about its functionality. Key changes include a new section clarifying that installing the add-on does not expose the Home Assistant interface to connected WireGuard peers. The installation instructions and configuration section have been reformatted and expanded for better usability, with detailed explanations and examples for various options. The troubleshooting section has also been improved with practical advice for common issues. 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: 2
Outside diff range and nitpick comments (16)
wireguard/DOCS.md (16)
4-4: Consider removing the extra space after the link syntax to maintain consistency and clean formatting.
Line range hint
21-21: Replace "an Hass.io" with "a Hass.io" for grammatical correctness.- including via an Hass.io add-on! + including via a Hass.io add-on!
Line range hint
30-30: Consider simplifying "a lot of" to a more concise expression to enhance clarity.- The add-on takes care of a lot of things for you (if you want). + The add-on manages many aspects for you (if you desire).
Line range hint
66-66: Simplify "is able to" to "can" for a more direct and clear expression.- The add-on is able to generate configurations for the add-on, but also for the + The add-on can generate configurations for the add-on, but also for the
Line range hint
130-130: Clarify the sentence to correct the missing auxiliary verb.- What this does, it effectively making your clients to have ad-filtering (e.g., your mobile phone), while not at home. + What this does is effectively make your clients have ad-filtering (e.g., your mobile phone), while not at home.
Line range hint
177-177: Standardize the phrase "By default" for consistency.- By default it executes the following: + By default, it executes the following: - By default it executes the following: + By default, it executes the following:Also applies to: 194-194
Line range hint
254-254: Add a determiner for grammatical accuracy.- from best security practice perspective, it is strongly advised to manually provide a public key for each of your peers. + from the best security practice perspective, it is strongly advised to manually provide a public key for each of your peers.
Line range hint
255-255: Avoid splitting the infinitive for a more formal tone.- it is strongly advised to manually provide a public key for each of your peers. + it is strongly advised to provide manually a public key for each of your peers.
Line range hint
291-291: Correct the grammatical structure by adding a possessive apostrophe.- A seconds interval, between 1 and 65535 inclusive, of how often to send an + A second's interval, between 1 and 65535 inclusive, of how often to send an
Line range hint
298-298: Standardize the phrase "By default" for consistency.- By default or when unspecified, this option is set + By default, or when unspecified, this option is set
Line range hint
316-316: Remove redundancy in the phrase for conciseness.- This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing + This option adds a layer of symmetric-key cryptography to be mixed into the already existing
Line range hint
364-364: Correct the hyphenation for grammatical accuracy.- during the start up. However, the add-on will work as advertised! + during the startup. However, the add-on will work as advertised!
Line range hint
367-367: Correct the preposition for grammatical accuracy.- the add-on falls back on a standalone instance of WireGuard running inside the add-on itself. + the add-on falls back to a standalone instance of WireGuard running inside the add-on itself.
Line range hint
370-370: Simplify the phrase for conciseness.- In order to run WireGuard optimal, you should install WireGuard on your + To run WireGuard optimally, you should install WireGuard on your
Line range hint
430-430: Simplify the phrase for conciseness.- There is one caveat to take into account: A partial backup of the add-on DOES NOT contain + One caveat to consider: A partial backup of the add-on DOES NOT contain
Line range hint
454-454: Simplify the phrase for conciseness.- At this moment, we do not have template or examples on how this could be + Currently, we do not have template or examples on how this could be
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- wireguard/DOCS.md (1 hunks)
Additional context used
LanguageTool
wireguard/DOCS.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...: WireGuard [WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that utilizes s...
[duplication] ~11-~11: Possible typo: you repeated a word
Context: ...to connected WireGuard peers. ## About WireGuard WireGuard aims to be faster, simpler, leaner, and...
[misspelling] ~21-~21: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...d) and widely deployable, including via an Hass.io add-on! WireGuard is currently...
[style] ~30-~30: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...minology used. The add-on takes care of a lot of things for you (if you want). Follow t...
[style] ~66-~66: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...however, one big difference: The add-on is able to generate configurations for the add-on,...
[grammar] ~130-~130: An auxiliary verb seems to be missing from this progressive structure. Did you mean “it's effectively making”, “it is effectively making”, or “it was effectively making”?
Context: ...r clients to use those. What this does, it effectively making your clients to have ad-filtering (e.g....
[uncategorized] ~177-~177: Did you mean: “By default,”?
Context: ...o"off", will disable that behavior. By default it executes the following: ```bash ipt...
[uncategorized] ~194-~194: Did you mean: “By default,”?
Context: ...o"off", will disable that behavior. By default it executes the following: ```bash ipt...
[grammar] ~254-~254: A determiner may be missing.
Context: ...n can generate public/private keypairs, from best security practice perspective, it is st...
[style] ~255-~255: Style-wise, it’s not ideal to insert an adverb (‘manually’) in the middle of an infinitive construction (‘to provide’). Try moving the adverb to avoid split infinitives.
Context: ...ty practice perspective, it is strongly advised to manually provide a public key for each of your peers. In that case, t...
[uncategorized] ~291-~291: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ....persistent_keep_alive` (optional) A seconds interval, between 1 and 65535 inclusive...
[uncategorized] ~298-~298: Did you mean: “By default,”?
Context: ...tent keepalive interval of 25 seconds. By default or when unspecified, this option is set...
[style] ~316-~316: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...y generated bywg genpsk. This option adds an additional layer of symmetric-key cryptography to be mix...
[uncategorized] ~335-~335: Loose punctuation mark.
Context: ...n issue. Possible values are: -trace: Show every detail, like all called inte...
[uncategorized] ~336-~336: Loose punctuation mark.
Context: ...all called internal functions. -debug: Shows detailed debug information. - `in...
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...ows detailed debug information. -info: Normal (usually) interesting events. - ...
[uncategorized] ~338-~338: Loose punctuation mark.
Context: ...usually) interesting events. -warning: Exceptional occurrences that are not er...
[uncategorized] ~339-~339: Loose punctuation mark.
Context: ...currences that are not errors. -error: Runtime errors that do not require imme...
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ... not require immediate action. -fatal: Something went terribly wrong. Add-on b...
[uncategorized] ~364-~364: When ‘start-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...-on to throw a large warning during the start up. However, the add-on will work as adver...
[uncategorized] ~367-~367: The preposition ‘to’ seems more likely in this position.
Context: ...hen this happens, the add-on falls back on a standalone instance of WireGuard runn...
[style] ~370-~370: Consider a shorter alternative to avoid wordiness.
Context: ...has drawbacks in terms of performance. In order to run WireGuard optimal, you should insta...
[style] ~430-~430: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...sistant Backups. There is one caveat to take into account: A partial backup of the add-on DOES NO...
[style] ~454-~454: For conciseness, consider replacing this expression with an adverb.
Context: ...esource: http://a0d7b954-wireguard ``` At this moment, we do not have template or examples on...
[uncategorized] ~476-~476: “you” seems less likely than “your” (belonging to you).
Context: ...dress. - If the initial connection from you client fails, this can be caused by r...
[uncategorized] ~493-~493: Loose punctuation mark.
Context: ...ented based on the following: -MAJOR: Incompatible or major changes. - `MINOR...
[uncategorized] ~494-~494: Loose punctuation mark.
Context: ...Incompatible or major changes. -MINOR: Backwards-compatible new features and e...
[uncategorized] ~495-~495: Loose punctuation mark.
Context: ...new features and enhancements. -PATCH: Backwards-compatible bugfixes and packa...
Markdownlint
wireguard/DOCS.md
4-4: Expected: 0 or 2; Actual: 1
Trailing spaces
11-11: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
the
stale
|
Does this comment count as "further activity"? |
github-actions
bot
removed
the
stale
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
stale
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
the
stale
|
@frenck It feels almost impolite to keep bumping my own PR every month. Could you maybe dial down the settings for the auto-stale bot? |
github-actions
bot
removed
the
stale
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
the
stale
|
That whole "Thank you for your contributions." spiel is beginning to sound a bit hollow, tbh. |
github-actions
bot
removed
the
stale
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
the
stale
|
HAL, reset the inactivity timer.
|
github-actions
bot
removed
the
stale
This commit moves some general WireGuard promo copy to its own heading, and adds a short summary of the add-on capabilities to the top of the documentation page.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
wireguard/DOCS.md (1)
2-2: Consider rephrasing to avoid overused intensifier.The word "extremely" could be replaced with a more precise descriptor.
-WireGuard® is an extremely simple yet fast and modern VPN that +WireGuard® is an elegantly simple yet fast and modern VPN that
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
wireguard/DOCS.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
wireguard/DOCS.md
[duplication] ~11-~11: Possible typo: you repeated a word
Context: ...to connected WireGuard peers. ## About WireGuard WireGuard aims to be faster, simpler, leaner, and...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (2)
wireguard/DOCS.md (2)
8-9: LGTM! Clear and important limitation note.
The addition of this note upfront helps set correct expectations for users about the add-on's capabilities.
Line range hint 11-24: LGTM! Well-structured promotional content.
The section effectively communicates WireGuard's benefits and current status. The repetition of "WireGuard" is acceptable as it's used in a heading followed by content about the product.
🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...: WireGuard [WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that utilizes s...
(EN_WEAK_ADJECTIVE)
[duplication] ~11-~11: Possible typo: you repeated a word
Context: ...to connected WireGuard peers. ## About WireGuard WireGuard aims to be faster, simpler, leaner, and...
(ENGLISH_WORD_REPEAT_RULE)
This commit moves some general WireGuard promo copy to its own heading, and adds a short summary of the add-on capabilities to the top of the documentation page.
After several hours of debugging spanning multiple days, I found issue #254, which concluded that what I was trying is apparently not possible. This PR adds this result to the top of the documentation page.
Summary by CodeRabbit