[host][mqtt] Document experimental host MQTT support#6028
[host][mqtt] Document experimental host MQTT support#6028tomers wants to merge 1 commit intoesphome:currentfrom
Conversation
Add a short note to the MQTT component docs and a host-platform example showing MQTT usage for development/testing.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis PR adds documentation for MQTT integration support on the host platform. It introduces a new MQTT integration section in the host platform documentation with configuration examples, and adds a clarifying note to the MQTT component documentation indicating host platform support with caveats about experimental status and feature limitations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Important Action Needed: IP Allowlist UpdateIf your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:
Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist. 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/components/host.md`:
- Around line 32-35: Replace the legacy Hugo shortcode in the "## MQTT
(optional)" section: find the `{{< docref "/components/mqtt" >}}` usage in
content/components/host.md and change it to a standard Markdown link (e.g., "the
MQTT component" or similar) pointing to /components/mqtt so the paragraph reads
with a normal Markdown link instead of the `docref` shortcode.
| ## MQTT (optional) | ||
|
|
||
| The `host` platform can be used with the {{< docref "/components/mqtt" >}} component for development/testing. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Replace legacy docref shortcode with a standard Markdown link.
The new section introduces a legacy {{< docref >}} shortcode, which is disallowed in **/*.md per guidelines. Use a normal Markdown link instead.
Proposed fix
-The `host` platform can be used with the {{< docref "/components/mqtt" >}} component for development/testing.
+The `host` platform can be used with the [MQTT component](/components/mqtt) for development/testing.As per coding guidelines, Hugo shortcode {{< docref >}} is legacy and should be replaced with standard Markdown links.
📝 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.
| ## MQTT (optional) | |
| The `host` platform can be used with the {{< docref "/components/mqtt" >}} component for development/testing. | |
| ## MQTT (optional) | |
| The `host` platform can be used with the [MQTT component](/components/mqtt) for development/testing. | |
🤖 Prompt for AI Agents
In `@content/components/host.md` around lines 32 - 35, Replace the legacy Hugo
shortcode in the "## MQTT (optional)" section: find the `{{< docref
"/components/mqtt" >}}` usage in content/components/host.md and change it to a
standard Markdown link (e.g., "the MQTT component" or similar) pointing to
/components/mqtt so the paragraph reads with a normal Markdown link instead of
the `docref` shortcode.
Summary
hostplatform.Test plan