Document manual_only option for addon boot mode #2286
Conversation
WalkthroughWalkthroughThe changes enhance the Home Assistant add-on configuration by updating the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Add-on
participant System
User->>System: Request add-on configuration
System->>Add-on: Retrieve boot configuration
Add-on-->>System: Return boot_config value
System-->>User: Display boot_config
sequenceDiagram
participant User
participant Add-on
participant System
User->>System: Set boot option to manual_only
System->>Add-on: Update boot configuration
Add-on-->>System: Confirm update
System-->>User: Boot option updated
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (2)
Files skipped from review as they are similar to previous changes (1)
Additional context usedLanguageTool
Markdownlint
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
mdegat01
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
docs/add-ons/configuration.md (1)
144-144: Improve readability and correctness.Add a comma after "system," add "the" before "addon," and add a trailing pipe to the table for consistency.
Apply this diff to improve readability and correctness:
-| `boot` | string | `auto` | `auto` start at boot is controlled by the system and `manual` configures the add-on to only be started manually. If addon should never be started at boot automatically, use `manual_only` to prevent users from changing it. +| `boot` | string | `auto` | `auto` start at boot is controlled by the system, and `manual` configures the add-on to only be started manually. If the addon should never be started at boot automatically, use `manual_only` to prevent users from changing it. |Tools
LanguageTool
[uncategorized] ~144-~144: Possible missing article found.
Context: ... add-on to only be started manually. If addon should never be started at boot automat...(AI_HYDRA_LEO_MISSING_THE)
Markdownlint
144-144: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
Proposed change
Document new
manual_onlyoption added for addon boot mode added in home-assistant/supervisor#5272Type of change
Additional information
manual_onlyoption to addon boot config supervisor#5272Summary by CodeRabbit
Summary by CodeRabbit
bootconfiguration option in add-ons, clarifying the use ofmanual_onlyto prevent automatic starts.boot_config, in the API documentation, allowing for more precise control over add-on boot behavior.