Document manual_only option for addon boot mode

[mdegat01]

Proposed change

Document new manual_only option added for addon boot mode added in https://github.com/home-assistant/supervisor/pull/5272

Type of change

• [ ] Document existing features within Home Assistant
• [x] Document new or changing features which there is an existing pull request elsewhere
• [ ] Spelling or grammatical corrections, or rewording for improved clarity
• [ ] Changes to the backend of this documentation
• [ ] Removed stale or deprecated documentation

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request: https://github.com/home-assistant/supervisor/pull/5272

Summary by CodeRabbit

Summary by CodeRabbit

• New Features
  • Expanded documentation for the boot configuration option in add-ons, clarifying the use of manual_only to prevent automatic starts.
  • Introduced a new field, boot_config, in the API documentation, allowing for more precise control over add-on boot behavior.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The changes enhance the Home Assistant add-on configuration by updating the `boot` option description to include a new value, `manual_only`, which prevents automatic starts at boot. Additionally, a new field, `boot_config`, has been introduced in the API documentation and response, allowing for a more precise specification of an add-on's boot mode. ## Changes | File | Change Summary | |-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| | docs/add-ons/configuration.md | Updated the `boot` configuration option description to include `manual_only`, clarifying its functionality and control over automatic starts. | | docs/api/supervisor/endpoints.md | Introduced a new field, `boot_config`, to represent the default boot mode of an add-on, enhancing the API's ability to specify boot behavior. | ## Sequence Diagram(s) ```mermaid 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 ``` ```mermaid 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 details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 251db8f2465cdad64173e50c1b40e405d7448a9a and 0a5f9b046d352b7accb921f67d92fbb87bd605d1.

Files selected for processing (2)

* docs/add-ons/configuration.md (1 hunks) * docs/api/supervisor/endpoints.md (2 hunks)

Files skipped from review as they are similar to previous changes (1)

* docs/api/supervisor/endpoints.md

Additional context used

LanguageTool

docs/add-ons/configuration.md

[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

docs/add-ons/configuration.md

144-144: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe Table pipe style (MD055, table-pipe-style)

--- 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?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.