Update nsw_fuel_station documentation #39348
Conversation
…e-assistant#39258) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Copilot <[email protected]>
…e-assistant#39278) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…t#39283) Co-authored-by: Joost Lekkerkerker <[email protected]>
…9302) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
To go with the update from yaml to config_flow.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis update includes documentation improvements, formatting standardization, and minor metadata enhancements across multiple markdown files. It introduces a new GitHub Actions workflow step to enforce Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub Actions
participant Workflow Step
participant Developer
GitHub Actions->>Workflow Step: Run markdown-lint job
Workflow Step->>Workflow Step: Search for .md files in source/_integrations
alt .md files found
Workflow Step->>Developer: Output file paths and warning
Workflow Step->>Workflow Step: Exit with status 1 (fail job)
else No .md files found
Workflow Step->>Workflow Step: Continue to next step
end
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (10)
Gemfile (1)
14-14: Enforce alphabetical ordering of gemsPer the Bundler/OrderedGems convention, gems within each group should be sorted alphabetically. Please move
rubocopso that it appears beforesass-embeddedin the development group.🧰 Tools
🪛 RuboCop (1.75.5)
[convention] 14-14: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
rubocopshould appear beforesass-embedded.(Bundler/OrderedGems)
source/_integrations/nsw_fuel_station.markdown (1)
32-33: Enhance the note with a callout for better visibility
This is important information—consider using a Markdown admonition or blockquote to surface it more prominently. For example:> **Note:** It's currently not possible to add or remove fuel types from a station that has already been added. You will need to remove all entries for that station and re-add them.source/_docs/authentication/providers.markdown (1)
164-164: Refine listing of authentication services
The phrase “from plaintext databases over LDAP to RADIUS” can read awkwardly. Consider simplifying to a comma-separated list for clarity.Apply:
- This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. + This provider can be used to integrate Home Assistant with arbitrary external authentication services, such as plaintext databases, LDAP, or RADIUS.source/voice_control/thirteen-usd-voice-remote.markdown (2)
73-73: Fix duplicate determiners in wizard step description.
The phrase has two determiners and an extra “the.” It should read “This starts a wizard to customize your voice assistant.”-6. This starts the a wizard to customize the your voice assistant. +6. This starts a wizard to customize your voice assistant.🧰 Tools
🪛 LanguageTool
[grammar] ~73-~73: Two determiners in a row. Choose either “the” or “a”.
Context: ...sp32-atom-flash-07.png) 6. This starts the a wizard to customize the your voice assi...(DT_DT)
[grammar] ~73-~73: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “your”?
Context: .... This starts the a wizard to customize the your voice assistant. - Follow the wizard...(A_MY)
103-103: Correct verb usage in troubleshooting link.
Use “Check out” (verb) instead of “Checkout” (noun).-- Checkout the [general troubleshooting section for Assist](/voice_control/troubleshooting/). +- Check out the [general troubleshooting section for Assist](/voice_control/troubleshooting/).🧰 Tools
🪛 LanguageTool
[grammar] ~103-~103: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ... Are things not working as expected? - Checkout the [general troubleshooting section fo...(SENT_START_NN_DT)
source/_integrations/esphome.markdown (1)
262-262: Ensure single trailing newline.
Add a single newline at the end of the file to satisfy markdownlint rule MD047.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
262-262: Files should end with a single newline character
null(MD047, single-trailing-newline)
source/_integrations/tts.markdown (4)
49-49: Add missing article for cache section reference.
Prepend “the” before the link and the option name for grammatical correctness.- See [cache section](#cache) for information on `cache` option. + See the [cache section](#cache) for information on the `cache` option.🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: You might be missing the article “the” here.
Context: ...che section](#cache) for information oncacheoption. Additional settings can b...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
62-62: Add missing article in legacysayaction docs.
Insert “the” before “cache” in the cache reference for consistency.- See [cache section](#cache) for information on `cache` option. + See the [cache section](#cache) for information on the `cache` option.🧰 Tools
🪛 LanguageTool
[uncategorized] ~62-~62: You might be missing the article “the” here.
Context: ...che section](#cache) for information oncacheoption. Additional settings can b...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
108-108: Hyphenate compound adjective in cache description.
Use “long-time cache” for better readability.- A long time cache will be located on the file system. + A long-time cache will be located on the file system.🧰 Tools
🪛 LanguageTool
[uncategorized] ~108-~108: This adjective is normally spelled with a hyphen (British English) or as one word (American English).
Context: ... (default), orFalseto disable it. A long time cache will be located on the file syste...(TIME_HYPHEN)
201-201: Improve grammar in Google Cast example.
Add the missing article and streamline the phrasing.- For example, some Google Cast devices skip initial audio part when the audio is sampled at 22050Hz, and to fix the problem it is required to set the `preferred_sample_rate` setting in the `options` option to `44100`. + For example, some Google Cast devices skip the initial audio part when the audio is sampled at 22050 Hz. To fix this, set the `preferred_sample_rate` in the `options` option to `44100`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~201-~201: You might be missing the article “the” here.
Context: ... example, some Google Cast devices skip initial audio part when the audio is sampled at...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~201-~201: Consider using a different verb for a more formal wording.
Context: ...the audio is sampled at 22050Hz, and to fix the problem it is required to set the `...(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.17.2)
201-201: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (2)
Gemfile.lockis excluded by!**/*.locksource/images/assist/esp32-atom_silence_detection_01.pngis excluded by!**/*.png
📒 Files selected for processing (15)
.github/workflows/test.yml(1 hunks)Gemfile(1 hunks)source/_docs/authentication/providers.markdown(1 hunks)source/_integrations/eafm.markdown(1 hunks)source/_integrations/esphome.markdown(7 hunks)source/_integrations/eve.markdown(1 hunks)source/_integrations/govee_ble.markdown(2 hunks)source/_integrations/ipp.markdown(1 hunks)source/_integrations/linkplay.markdown(1 hunks)source/_integrations/locative.markdown(1 hunks)source/_integrations/motionmount.markdown(1 hunks)source/_integrations/nsw_fuel_station.markdown(1 hunks)source/_integrations/tts.markdown(4 hunks)source/voice_control/index.markdown(2 hunks)source/voice_control/thirteen-usd-voice-remote.markdown(3 hunks)
🧰 Additional context used
🪛 RuboCop (1.75.5)
Gemfile
[convention] 14-14: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem rubocop should appear before sass-embedded.
(Bundler/OrderedGems)
🪛 LanguageTool
source/_integrations/locative.markdown
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://www.locative.app/). Locative is an open source app for [iOS](https://apps.apple.com/us...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~17-~17: As a shorter alternative for ‘able to’, consider using “can not”.
Context: ... that URL, updating Home Assistant. You are not able to specify a device name in Locative. Inst...
(BE_ABLE_TO)
[uncategorized] ~17-~17: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...have created on its first GET. If you had been or are using Owntracks as well, yo...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
source/_integrations/linkplay.markdown
[grammar] ~48-~48: Did you mean “saving”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ... Companion apps, such as 4stream, allow to save music presets (for example, Spotify pla...
(ALLOW_TO)
source/_integrations/motionmount.markdown
[grammar] ~51-~51: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ets. Changes to the presets are {% term polling polled %}, by default every 60 seconds.
...
(REPEATED_VERBS)
source/voice_control/thirteen-usd-voice-remote.markdown
[grammar] ~73-~73: Two determiners in a row. Choose either “the” or “a”.
Context: ...sp32-atom-flash-07.png) 6. This starts the a wizard to customize the your voice assi...
(DT_DT)
[grammar] ~73-~73: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “your”?
Context: .... This starts the a wizard to customize the your voice assistant. - Follow the wizard...
(A_MY)
source/_integrations/nsw_fuel_station.markdown
[typographical] ~23-~23: Consider adding a comma after ‘Typically’ for more clarity.
Context: ...nter a search string to find a station. Typically this will be a suburb, street, or postc...
(RB_LY_COMMA)
source/_integrations/esphome.markdown
[misspelling] ~120-~120: This word is normally spelled as one.
Context: ...Protocol**: ESPHome uses a lightweight, bi-directional protocol over TCP, optimized for microc...
(EN_COMPOUNDS_BI_DIRECTIONAL)
source/_integrations/tts.markdown
[uncategorized] ~49-~49: You might be missing the article “the” here.
Context: ...che section](#cache) for information on cache option. Additional settings can b...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~62-~62: You might be missing the article “the” here.
Context: ...che section](#cache) for information on cache option. Additional settings can b...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~108-~108: This adjective is normally spelled with a hyphen (British English) or as one word (American English).
Context: ... (default), or False to disable it. A long time cache will be located on the file syste...
(TIME_HYPHEN)
[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...all optional, are: - preferred_format: Set the audio format. When not supporte...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ... output files. - preferred_sample_rate: Set the sample rate. When not supported...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~120-~120: Loose punctuation mark.
Context: ...mpeg tool. - preferred_sample_channels: Set the number of audio channels. When ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~121-~121: Loose punctuation mark.
Context: ... FFmpeg tool. - preferred_sample_bytes: Set the audio bit sampling. When not su...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...ored). Example to produce an MP3 audio at 22050Hz: ```yaml action: tts.speak tar...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~199-~199: It appears that a comma is missing.
Context: ... format is not fully supported. In such cases it is required to experiment with diffe...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~201-~201: You might be missing the article “the” here.
Context: ... example, some Google Cast devices skip initial audio part when the audio is sampled at...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~201-~201: Consider using a different verb for a more formal wording.
Context: ...the audio is sampled at 22050Hz, and to fix the problem it is required to set the `...
(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/locative.markdown
20-20: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
source/_integrations/linkplay.markdown
25-25: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
29-29: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
30-30: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
45-45: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
48-48: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
53-53: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
54-54: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
source/_integrations/esphome.markdown
262-262: Files should end with a single newline character
null
(MD047, single-trailing-newline)
source/_integrations/tts.markdown
201-201: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/nsw_fuel_station.markdown
[error] 27-27: Textlint: This is a commonly misspelled word. Correct it to which (common-misspellings). Run 'textlint --fix' to fix.
🔇 Additional comments (27)
Gemfile (1)
14-14: Bump RuboCop version to 1.75.8The version bump in the development group is appropriate and keeps linting up to date.
🧰 Tools
🪛 RuboCop (1.75.5)
[convention] 14-14: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
rubocopshould appear beforesass-embedded.(Bundler/OrderedGems)
source/_integrations/nsw_fuel_station.markdown (2)
19-19: Good: Using the shared config_flow include
Including the standardintegrations/config_flow.mdsnippet aligns this doc with other config-flow–based integrations.
30-30: Section header is clear
The “## Changing station fuel types” heading clearly communicates the intent of the note.source/voice_control/index.markdown (2)
33-33: Consistency with sentence case
The header has been updated to sentence case (“Getting started”) to align with the project’s style guidelines.
44-44: Consistency with sentence case
This header update (“Expand and experiment”) also matches the sentence-case convention used elsewhere.source/_integrations/govee_ble.markdown (2)
35-35: Add H5075 device with active scan notice
The new H5075 entry is formatted correctly and includes the required “(Active scans required)” note, matching the style of existing device listings.
52-52: Include H5129 device documentation
The H5129 entry is added with a proper link and active-scan requirement. This keeps the supported-devices list up to date.source/_integrations/linkplay.markdown (2)
1-1: Standardize frontmatter delimiters
The opening YAML frontmatter delimiter is correctly set to three dashes (---), aligning with the documentation conventions.
17-17: Standardize frontmatter delimiters
The closing frontmatter delimiter is now three dashes, matching the opening delimiter and adhering to format standards..github/workflows/test.yml (1)
17-26: Enforce.markdownextensions for integration docs
The new workflow step correctly scans for.mdfiles undersource/_integrationsand fails the job with a clear message, ensuring all integration docs adopt the.markdownextension.source/_integrations/eafm.markdown (1)
1-1: Standardize frontmatter delimiters: Changed both opening and closing delimiters from four dashes to the conventional---, ensuring consistency with Jekyll/documentation tooling requirements.Also applies to: 11-11
source/_integrations/locative.markdown (1)
1-1: Standardize frontmatter delimiters: Updated the frontmatter to use---for both the start and end markers, aligning with repository-wide docs standards.Also applies to: 9-9
source/_integrations/ipp.markdown (1)
1-1: Standardize frontmatter delimiters: Switched metadata block delimiters to---for uniform formatting across integration pages.Also applies to: 12-12
source/_integrations/eve.markdown (1)
16-17: Addworks_withmetadata: The newworks_with: matterfield clearly indicates Matter compatibility. Please verify this frontmatter key is recognized by the documentation schema and that CI passes without errors.source/_integrations/motionmount.markdown (1)
1-116: Inconsistent AI-generated summary: The summary claims list markers were converted from-to+, but the provided code still uses hyphens. Please confirm whether the formatting changes were intended or update the summary to reflect the actual modifications.Likely an incorrect or invalid review comment.
🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ets. Changes to the presets are {% term polling polled %}, by default every 60 seconds....
(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
116-116: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
source/voice_control/thirteen-usd-voice-remote.markdown (3)
81-81: Approve generalized wake word example.
Using a placeholder wake word (“OK, Nabu”) aligns with user-configured wake words and improves clarity.
93-95: Approve instructions for adjusting silence detection.
The added steps correctly guide users to the ESPHome integration settings to modify the “Finished speaking detection” value.🧰 Tools
🪛 LanguageTool
[uncategorized] ~95-~95: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... for Assist to find you're done speaking and it can start processing your command. ...(COMMA_COMPOUND_SENTENCE)
105-121: Approve new Wi-Fi credential removal section.
This section clearly explains how to erase stored Wi-Fi credentials while retaining firmware and aligns with the new config_flow approach.source/_integrations/esphome.markdown (2)
52-52: Approve term syntax for integration reference.
Using{% term integration %}here aligns with other integration docs, improving consistency.
56-56: Approve sentence-case heading.
Changing “Key Features” to “Key features” matches the style guidelines for Markdown headings.source/_integrations/tts.markdown (7)
110-110: Approve “Preferred audio settings” heading.
The new heading accurately introduces the section and follows style guidelines.
112-112: Approve FFmpeg integration detail.
The note about using FFmpeg for transcoding is clear and informative.
116-116: Approve listing of preferred audio settings.
The list of options is comprehensive and well organized.
123-123: Approve MP3 example snippet.
The code example correctly demonstrates setting preferred format and sample rate.🧰 Tools
🪛 LanguageTool
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...ored). Example to produce an MP3 audio at 22050Hz: ```yaml action: tts.speak tar...(AI_HYDRA_LEO_MISSING_COMMA)
141-141: Approve REST API update.
The addition ofcache,language, andoptionsparameters is clearly documented.
197-197: Approve new troubleshooting subsection heading.
Adding “Partial, corrupted or no audio” enhances the troubleshooting coverage.
199-199: Approve guidance for audio troubleshooting.
Encouraging experimentation with preferred settings gives users actionable advice.🧰 Tools
🪛 LanguageTool
[typographical] ~199-~199: It appears that a comma is missing.
Context: ... format is not fully supported. In such cases it is required to experiment with diffe...(DURING_THAT_TIME_COMMA)
To go with the update from yaml to config_flow.
Proposed change
Update documentation to go with home-assistant/core#146001
That PR updates the integration from legacy yaml to config_flow.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Documentation
Chores