Update and tweak add-on docs #2754
Conversation
📝 WalkthroughWalkthroughDocumentation updates in docs/add-ons/tutorial.md adjust capitalization, keyboard markup, navigation instructions to logs, and inline code formatting for keys and examples. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/add-ons/tutorial.md (3)
83-83: Use the exact UI label and hyphenate "bottom-right".The button label in the UI is "Add-on Store" (capital S). Also, compound modifiers should be hyphenated.
Apply this diff:
- - Click "Add-on store" in the bottom right corner. + - Click "Add-on Store" in the bottom-right corner.
104-104: Tighten wording, add macOS hard-refresh shortcut, capitalize Supervisor, and use HTTPS for yamllint.Improves clarity and cross-platform guidance, aligns capitalization, and switches to HTTPS.
Apply this diff:
-When this happens, try refreshing your browser's cache first by pressing <kbd>Ctrl</kbd> + <kbd>F5</kbd>. If that didn't help, it means that your `config.yaml` is invalid. It's either [invalid YAML](http://www.yamllint.com/) or one of the specified options is incorrect. To see what went wrong, go to ["Settings" → "System" → "Logs" and select "Supervisor" in the top-right drop-down menu](https://my.home-assistant.io/redirect/logs/?provider=supervisor). This should bring you to a page with the logs of the supervisor. Scroll to the bottom and you should be able to find the validation error. +When this happens, try refreshing your browser's cache by pressing <kbd>Ctrl</kbd> + <kbd>F5</kbd> (Windows/Linux) or <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>R</kbd> (macOS). If that doesn't help, your `config.yaml` is invalid. It's either [invalid YAML](https://www.yamllint.com/) or one of the specified options is incorrect. To see what went wrong, go to ["Settings" → "System" → "Logs", then select "Supervisor" in the top-right drop-down menu](https://my.home-assistant.io/redirect/logs/?provider=supervisor). This opens the Supervisor logs page. Scroll to the bottom to find the validation error.
179-179: Minor phrasing improvement for readability.Prefer “one file” in prose and a slightly smoother sentence.
Apply this diff:
-In the screenshot you've probably seen that our server only served up 1 file: `options.json`. This file contains the user configuration for this add-on. Because we specified two empty objects for the `options` and `schema` keys in our `config.yaml`, the resulting file is currently empty. +In the screenshot, you've probably seen that our server served only one file: `options.json`. This file contains the user configuration for this add-on. Because we specified two empty objects for the `options` and `schema` keys in our `config.yaml`, the resulting file is currently empty.
📜 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
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/add-ons/tutorial.md(3 hunks)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/add-ons/tutorial.md (2)
83-83: Hyphenate “bottom-right”; confirm UI label capitalizationMinor grammar: use “bottom-right.” Also, please verify whether the UI label reads “Add-on store” or “Add-on Store” in the current HA UI to keep terminology consistent.
Proposed tweak:
- - Click "Add-on store" in the bottom right corner. + - Click "Add-on store" in the bottom-right corner.
104-104: Add macOS hard-reload keys and capitalize “Supervisor”Nice improvement with keyboard markup and direct logs link. Suggest adding the macOS shortcut and capitalizing “Supervisor” as a proper noun.
Proposed edit:
-When this happens, try refreshing your browser's cache first by pressing <kbd>Ctrl</kbd> + <kbd>F5</kbd>. If that didn't help, it means that your `config.yaml` is invalid. It's either [invalid YAML](http://www.yamllint.com/) or one of the specified options is incorrect. To see what went wrong, go to ["Settings" → "System" → "Logs" and select "Supervisor" in the top-right drop-down menu](https://my.home-assistant.io/redirect/logs/?provider=supervisor). This should bring you to a page with the logs of the supervisor. Scroll to the bottom and you should be able to find the validation error. +When this happens, try refreshing your browser's cache first by pressing <kbd>Ctrl</kbd> + <kbd>F5</kbd> (Windows/Linux) or <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>R</kbd> (macOS). If that doesn't help, it means that your `config.yaml` is invalid—it's either [invalid YAML](http://www.yamllint.com/) or one of the specified options is incorrect. To see what went wrong, go to ["Settings" → "System" → "Logs" and select "Supervisor" in the top-right dropdown menu](https://my.home-assistant.io/redirect/logs/?provider=supervisor). This should bring you to a page with the logs of the Supervisor. Scroll to the bottom and you should be able to find the validation error.
📜 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
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/add-ons/tutorial.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
🔇 Additional comments (1)
docs/add-ons/tutorial.md (1)
179-179: Good call on code-formatting keys for clarityUsing backticks for the options/schema keys improves readability and consistency with config snippets.
Proposed change
Update docs to access supervisor logs plus some small formatting tweaks.
Type of change
Checklist
Summary by CodeRabbit