Skip to content

[host][mqtt] Document experimental host MQTT support#6028

Open
tomers wants to merge 1 commit intoesphome:currentfrom
tomers:docs/host-mqtt-support
Open

[host][mqtt] Document experimental host MQTT support#6028
tomers wants to merge 1 commit intoesphome:currentfrom
tomers:docs/host-mqtt-support

Conversation

@tomers
Copy link

@tomers tomers commented Feb 4, 2026

Summary

  • Document experimental MQTT support on the host platform.
  • Add a host example showing MQTT usage for dashboard/CLI discovery and status.

Test plan

  • Preview docs build renders as expected.

Add a short note to the MQTT component docs and a host-platform example showing MQTT usage for development/testing.
@esphome esphome bot added the current label Feb 4, 2026
@netlify
Copy link

netlify bot commented Feb 4, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 08196d9
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6982b5054f121f0008803e83
😎 Deploy Preview https://deploy-preview-6028--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

Walkthrough

This 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

Cohort / File(s) Summary
MQTT Host Platform Documentation
content/components/host.md, content/components/mqtt.md
Added MQTT integration documentation for host platform, including configuration example with broker and discovery settings in host.md, and clarification note in mqtt.md about host platform support being experimental with limited features.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Document host platform #3893: Introduces initial host platform documentation that this PR builds upon by adding MQTT-specific integration details.

Suggested labels

current

Suggested reviewers

  • nagyrobi
  • frenck
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: documenting experimental MQTT support for the host platform.
Description check ✅ Passed The description is directly related to the changeset, explaining the addition of MQTT documentation and examples for the host platform.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

  • 136.113.208.247/32 (new)
  • 34.170.211.100/32
  • 35.222.179.152/32

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +32 to +35
## MQTT (optional)

The `host` platform can be used with the {{< docref "/components/mqtt" >}} component for development/testing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ 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.

Suggested change
## 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments