Add links to discovery methods in documentation#3031
Add links to discovery methods in documentation#3031JensTimmerman wants to merge 2 commits intohome-assistant:masterfrom
Conversation
Updated discovery methods with links to integration manifest documentation.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughConverted 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 Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 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)
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
🤖 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
📒 Files selected for processing (1)
docs/core/integration-quality-scale/rules/discovery.md
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
Checklist
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
Summary by CodeRabbit