Skip to content

Add links to discovery methods in documentation#3031

Merged
MartinHjelmare merged 3 commits intohome-assistant:masterfrom
JensTimmerman:patch-2
Apr 7, 2026
Merged

Add links to discovery methods in documentation#3031
MartinHjelmare merged 3 commits intohome-assistant:masterfrom
JensTimmerman:patch-2

Conversation

@JensTimmerman
Copy link
Copy Markdown
Contributor

@JensTimmerman JensTimmerman commented Apr 5, 2026

Updated discovery methods with links to integration manifest documentation.

Proposed change

In the discovery documentation, link to the specifics the dev needs to implement for each specific method (Currently it's a bit hard to find since there are no direct links that the discovery needs to be put in the manifest and what functions to add for this)

Possibly something similar should be done to https://developers.home-assistant.io/docs/network_discovery ?
Or the pages/docs should be rearanged a bit so everyhthing fits better togheter? Since network_discovery perhaps could contain the part of the docs that are in the manifest doc now?

Type of change

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

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.:
    I have not, How do I do this? The documentation states: When you create a pull request (PR), you can see a preview of the proposed changes by clicking the Deploy Preview link in the Netlify comment. But I can't find the netlify comment here.

Additional information

  • This PR fixes or closes issue: fixes
  • Link to relevant existing code or pull request: Added guntamatic heater integration core#167419 In this pr I was told to look into auto discovery, I initially missed the dhcp discovery option because there was no direct links to how to set this up an how it works.

Summary by CodeRabbit

  • Documentation
    • Protocol names for discovery (Bluetooth, DHCP, HomeKit, mDNS/ZeroConf, MQTT, SSDP, USB) are now direct links to their integration manifest sections for easier navigation.
    • Corrected the mDNS/ZeroConf link and added an "Additional resources" sentence linking to integration manifest guidance on discovery methods.
    • Minor end-of-document formatting fix.

Updated discovery methods with links to integration manifest documentation.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e3214289-0160-45ec-9602-fcba852a49eb

📥 Commits

Reviewing files that changed from the base of the PR and between d716fa0 and f017888.

📒 Files selected for processing (1)
  • docs/core/integration-quality-scale/rules/discovery.md
✅ Files skipped from review due to trivial changes (1)
  • docs/core/integration-quality-scale/rules/discovery.md

📝 Walkthrough

Walkthrough

Converted protocol names (Bluetooth, DHCP, HomeKit, mDNS, MQTT, SSDP, USB) to links pointing at specific sections of the integration manifest docs, changed the mDNS entry to use the #zeroconf anchor, added a manifest-docs reference under "Additional resources", and fixed the missing EOF newline.

Changes

Cohort / File(s) Summary
Documentation Links
docs/core/integration-quality-scale/rules/discovery.md
Converted plain protocol/method names into links to integration manifest sections (mDNS -> #zeroconf), added a sentence in "Additional resources" linking to the integration manifest docs for specifying discovery methods, and fixed missing newline at EOF.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the proposed change, type of change, and additional context. However, the author did not verify that changes render correctly (unchecked checkbox with explanation), which is a required checklist item. Complete the checklist by verifying changes render correctly using the Netlify preview link that should appear in the PR comments, or document why verification was not possible.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add links to discovery methods in documentation' clearly and accurately summarizes the main change: adding hyperlinks to discovery method documentation.
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

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
Copy Markdown
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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/core/integration-quality-scale/rules/discovery.md`:
- Around line 16-22: The listed discovery links (Bluetooth, DHCP, HomeKit, mDNS,
MQTT, SSDP, USB) use relative paths like "docs/..." which can break in nested
docs; update each link target to use root-relative paths ("/docs/...") including
the similar occurrence around the Home Assistant docs reference at the later
section (the mention at line ~118) so all entries point to
"/docs/creating_integration_manifest#Bluetooth",
"/docs/creating_integration_manifest#DHCP",
"/docs/creating_integration_manifest#HomeKit",
"/docs/creating_integration_manifest#Zeroconf",
"/docs/creating_integration_manifest#MQTT",
"/docs/creating_integration_manifest#SSDP", and
"/docs/creating_integration_manifest#USB" respectively.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8a6e4bde-c1f9-45c9-91bc-62615e71fb40

📥 Commits

Reviewing files that changed from the base of the PR and between bdf53bc and a226761.

📒 Files selected for processing (1)
  • docs/core/integration-quality-scale/rules/discovery.md

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Please adjust the anchors. They should all be all lowercase. eg /docs/creating_integration_manifest#ssdp.

- [Bluetooth](/docs/creating_integration_manifest#bluetooth)
- [DHCP](/docs/creating_integration_manifest#DHCP)
- [HomeKit](/docs/creating_integration_manifest#HomeKit)
- [mDNS](/docs/creating_integration_manifest#Zeroconf)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
- [mDNS](/docs/creating_integration_manifest#Zeroconf)
- [mDNS](/docs/creating_integration_manifest#zeroconf)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

@home-assistant home-assistant bot marked this pull request as draft April 7, 2026 08:42
@home-assistant
Copy link
Copy Markdown

home-assistant bot commented Apr 7, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@JensTimmerman JensTimmerman marked this pull request as ready for review April 7, 2026 08:45
@home-assistant home-assistant bot requested a review from MartinHjelmare April 7, 2026 08:45
@JensTimmerman
Copy link
Copy Markdown
Contributor Author

@MartinHjelmare I'm not sure this is enought currently, see the question in my PR:

Possibly something similar should be done to https://developers.home-assistant.io/docs/network_discovery ?
Or the pages/docs should be rearanged a bit so everyhthing fits better togheter? Since network_discovery perhaps could contain the part of the docs that are in the manifest doc now?

@MartinHjelmare
Copy link
Copy Markdown
Member

I think we can link to the discovery page from the manifest sections.

I can't answer about larger redesigns of the docs. You can make a suggestion and we can discuss it.

@MartinHjelmare
Copy link
Copy Markdown
Member

But let's do further changes in separate PRs. This PR is good in the current scope.

@MartinHjelmare MartinHjelmare merged commit b9c250b into home-assistant:master Apr 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants