Rewrite Tesla Fleet changes #39736
Rewrite Tesla Fleet changes #39736
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe Tesla Fleet integration documentation was reorganized and clarified, providing a more structured step-by-step guide for setup, simplifying prerequisites, and updating instructions for developer application creation, public key hosting, and integration setup. Additional clarifications and a new section on generating key pairs were included, while redundant content was removed. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant TeslaDeveloperPortal
participant WebDomain
User->>TeslaDeveloperPortal: Create Developer Application
User->>WebDomain: Host public key
User->>HomeAssistant: Enter application credentials
HomeAssistant->>TeslaDeveloperPortal: Authenticate with Tesla
TeslaDeveloperPortal-->>User: Redirect back to HomeAssistant
User->>HomeAssistant: Enter domain for public key
HomeAssistant->>TeslaDeveloperPortal: Register public key
HomeAssistant->>User: Instruct to install virtual key on vehicles
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: 2
🧹 Nitpick comments (3)
source/_integrations/tesla_fleet.markdown (3)
88-93: Missing heading – the numbered list appears without context.
config_flow.mdinjects its own “## Configuration” heading.
Add a subordinate heading (e.g.### Setup flow) before the step-by-step list to keep the structure consistent with the integration-docs template.{% include integrations/config_flow.md %} +### Setup flow + 1. Add application credentials
141-141: Use the verb phrase “set up”, not the noun “setup”.-… if this is required and the key has not been setup correctly. +… if this is required and the key has not been set up correctly.
146-146: Missing comma after introductory phrase.-For more details see [Tesla Fleet API vehicle commands documentation]… +For more details, see [Tesla Fleet API vehicle commands documentation]…
📜 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 selected for processing (1)
source/_integrations/tesla_fleet.markdown(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/tesla_fleet.markdown
🪛 LanguageTool
source/_integrations/tesla_fleet.markdown
[grammar] ~135-~135: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...tes The {% term integration %} {% term polling polls %} each vehicle every 10 minutes while ...
(REPEATED_VERBS)
[grammar] ~141-~141: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...is is required and the key has not been setup correctly. Your public key must be add...
(BE_VB_OR_NN)
[uncategorized] ~146-~146: Possible missing comma found.
Context: ...webpage and finish the setup. For more details see [Tesla Fleet API vehicle commands d...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| {% warning %} | ||
| The China region is currently not supported by this {% term integration %}. | ||
| {% endwarning %} |
There was a problem hiding this comment.
Admonition shortcode syntax is off – switch to {{% warning %}} … {{% /warning %}}.
Home Assistant docs use Hugo shortcodes wrapped in double curly braces.
{% warning %} / {% endwarning %} will not be rendered and the notice will leak verbatim into the page.
-{% warning %}
+{{% warning %}}
...
-{% endwarning %}
+{{% /warning %}}📝 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.
| {% warning %} | |
| The China region is currently not supported by this {% term integration %}. | |
| {% endwarning %} | |
| {{% warning %}} | |
| The China region is currently not supported by this {% term integration %}. | |
| {{% /warning %}} |
🤖 Prompt for AI Agents
In source/_integrations/tesla_fleet.markdown around lines 50 to 52, the
admonition shortcode uses incorrect syntax with single curly braces `{% warning
%}` and `{% endwarning %}` which will not render properly. Replace these with
the correct Hugo shortcode syntax using double curly braces: `{{% warning %}}`
and `{{% /warning %}}` to ensure the warning block renders correctly on the
page.
| {% note %} | ||
| Tesla charges for API calls starting January 2025. The default polling interval is optimized to stay within the free tier for typical usage. | ||
| {% endnote %} | ||
| The {% term integration %} {% term polling polls %} each vehicle every 10 minutes while it's awake. This is designed to stay within Tesla's $10 monthly credit for most users, which you can monitor usage in the [Tesla Developer Dashboard](https://developer.tesla.com/en_US/dashboard). Energy product APIs are free to use. |
There was a problem hiding this comment.
Duplicate verb: “polling polls”.
Streamline the sentence and avoid the grammar issue flagged by LanguageTool.
-The {% term integration %} {% term polling polls %} each vehicle every 10 minutes while it's awake.
+The {% term integration %} performs {% term polling %} of each vehicle every 10 minutes while it is awake.📝 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 {% term integration %} {% term polling polls %} each vehicle every 10 minutes while it's awake. This is designed to stay within Tesla's $10 monthly credit for most users, which you can monitor usage in the [Tesla Developer Dashboard](https://developer.tesla.com/en_US/dashboard). Energy product APIs are free to use. | |
| The {% term integration %} performs {% term polling %} of each vehicle every 10 minutes while it is awake. This is designed to stay within Tesla's $10 monthly credit for most users, which you can monitor usage in the [Tesla Developer Dashboard](https://developer.tesla.com/en_US/dashboard). Energy product APIs are free to use. |
🧰 Tools
🪛 LanguageTool
[grammar] ~135-~135: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...tes The {% term integration %} {% term polling polls %} each vehicle every 10 minutes while ...
(REPEATED_VERBS)
🤖 Prompt for AI Agents
In source/_integrations/tesla_fleet.markdown at line 135, the phrase "polling
polls" is a duplicate verb causing a grammar issue. Remove one of the verbs to
streamline the sentence, for example, use either "polling" or "polls" but not
both together, ensuring the sentence remains clear and grammatically correct.
Proposed change
Changes from #39542 seemly got lost in a merge.
This rewrites the Tesla Fleet documentation to be accurate with the upcoming release
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit