Skip to content

Add my links to network browsers #38890

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

Jump to bottom
Merged
merged 5 commits into from
May 6, 2025
Merged

Add my links to network browsers #38890

merged 5 commits into from
May 6, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 5, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Add my links to network browsers

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Added troubleshooting sections to the DHCP, SSDP, and Zeroconf integration documentation, introducing new browser features for viewing discovered devices and providing step-by-step navigation instructions within the Home Assistant interface.

@bdraco bdraco added this to the 2025.5 milestone May 5, 2025
@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels May 5, 2025
@netlify Netlify
Copy link

netlify bot commented May 5, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 15e4c88
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6819a50373f79600081823df
😎 Deploy Preview https://deploy-preview-38890--home-assistant-docs.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 site configuration.

@bdraco bdraco marked this pull request as ready for review May 5, 2025 21:33
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 5, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The documentation for the DHCP, SSDP, and Zeroconf integrations was updated to include new troubleshooting sections describing browser tools within Home Assistant. These sections explain how each browser displays devices discovered via their respective protocols and provide instructions for accessing the browsers through the Home Assistant user interface.

Changes

File(s) Change Summary
source/_integrations/dhcp.markdown Added a "Troubleshooting" section describing the DHCP Browser, its function, and navigation instructions.
source/_integrations/ssdp.markdown Added a "Troubleshooting" section about the SSDP/UPnP Browser, its purpose, and UI access path.
source/_integrations/zeroconf.markdown Added a "Zeroconf Browser" subsection under Troubleshooting, detailing its use and UI navigation steps.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistantUI
    participant DiscoveryBrowser

    User->>HomeAssistantUI: Navigate to Settings > System > Network > [DHCP/SSDP/Zeroconf] Browser
    HomeAssistantUI->>DiscoveryBrowser: Open selected protocol browser
    DiscoveryBrowser->>HomeAssistantUI: Display list of discovered devices
    HomeAssistantUI->>User: Show device discovery results
Loading
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 18ba646 and 15e4c88.

📒 Files selected for processing (3)
  • source/_integrations/dhcp.markdown (1 hunks)
  • source/_integrations/ssdp.markdown (1 hunks)
  • source/_integrations/zeroconf.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • source/_integrations/zeroconf.markdown
  • source/_integrations/dhcp.markdown
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ssdp.markdown

[uncategorized] ~30-~30: You might be missing the article “the” here.
Context: ... to announce themselves on the network. Home Assistant listens for these broadcasts ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🔇 Additional comments (3)
source/_integrations/ssdp.markdown (3)

26-28: Headings are consistent and clear.

The new “Troubleshooting” section and its “SSDP/UPnP Browser” subheading follow the established pattern used across other network discovery integrations. They are at the correct heading levels and accurately describe the content that follows.

30-30: Description is concise and accurate.

The explanation of how SSDP/UPnP broadcasts are used by Home Assistant is clear, technically correct, and matches similar sections in the DHCP and Zeroconf docs.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~30-~30: You might be missing the article “the” here.
Context: ... to announce themselves on the network. Home Assistant listens for these broadcasts ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

32-33: Configuration snippet matches UI navigation.

The {% my config_ssdp %} directive uses the correct title formatting and navigation path consistent with other “Browser” links in the docs. This will render the proper link in the UI under Settings > System > Network > SSDP Browser.

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

c0ffeeca7
c0ffeeca7 reviewed May 6, 2025
View reviewed changes
c0ffeeca7
c0ffeeca7 approved these changes May 6, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @bdraco 👍

@c0ffeeca7 c0ffeeca7 merged commit e987673 into next May 6, 2025
9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the network_my branch May 6, 2025 06:05
@bdraco
Copy link
Member Author

bdraco commented May 6, 2025

Thanks

@frenck frenck added the cherry-picked This PR has been manually picked and merged into the current branch label May 6, 2025
frenck pushed a commit that referenced this pull request May 6, 2025
@bdraco @c0ffeeca7 @frenck
Add my links to network browsers (#38890)
e93c113 
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
cherry-picked This PR has been manually picked and merged into the current branch has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
2025.5
Development

Successfully merging this pull request may close these issues.
3 participants
@bdraco @c0ffeeca7 @frenck