Skip to content

Add links to discovery methods in documentation #3031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinHjelmare merged 3 commits into from
Apr 7, 2026
Merged

Add links to discovery methods in documentation #3031

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a226761
Add links to discovery methods in documentation
JensTimmerman Apr 5, 2026
d716fa0
Fix links in discovery documentation
JensTimmerman Apr 5, 2026
f017888
Fix link casing in discovery.md for consistency
JensTimmerman Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/core/integration-quality-scale/rules/discovery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ import RelatedRules from './_includes/related_rules.jsx'
A lot of devices have the ability to be discovered.
This can happen using one of the following methods:
- App (formerly known as add-ons)
- Bluetooth
- DHCP
- HomeKit
- mDNS
- MQTT
- SSDP
- USB
- [Bluetooth](/docs/creating_integration_manifest#bluetooth)
- [DHCP](/docs/creating_integration_manifest#dhcp)
- [HomeKit](/docs/creating_integration_manifest#homekit)
- [mDNS](/docs/creating_integration_manifest#zeroconf)
- [MQTT](/docs/creating_integration_manifest#mqtt)
- [SSDP](/docs/creating_integration_manifest#ssdp)
- [USB](/docs/creating_integration_manifest#usb)

This is a great way to make it easier for users to find and set up devices, since they don't have to manually look up which integration to use and then enter the host.
This greatly reduces the effort required to set up a device and thus improves the user experience.
Expand Down Expand Up @@ -115,6 +115,7 @@ class MyConfigFlow(ConfigFlow, domain=DOMAIN):
To learn more information about config flows, checkout the [config flow documentation](/docs/config_entries_config_flow_handler).
To learn more about discovery on network protocols, checkout the [Networking and discovery documentation](/docs/network_discovery).
To learn more about discovery for bluetooth devices, checkout the [Bluetooth documentation](/docs/bluetooth).
To learn more about specifying different discovery methods in your manifest checkout the [Integration Manifest Documentation](/docs/creating_integration_manifest).

## Exceptions

Expand All @@ -123,4 +124,4 @@ Integrations where the devices can't be discovered are exempt from this rule.

## Related rules

<RelatedRules relatedRules={frontMatter.related_rules}></RelatedRules>
<RelatedRules relatedRules={frontMatter.related_rules}></RelatedRules>