home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Rework AVM FRITZ!SmartHome docs

Open mib1185 opened this issue 1 year ago • 2 comments

Proposed change

This reworks the docs to be more clear about the integrateable devices and what the user can expect to do with them. List of changes

  • reflect the product line renaming from "AVM FRITZ!DECT" to "AVM Smart Home"
  • structure the whole docs based on the integrateable devices
  • make clear how these devices will be represented in HA and what possible further entities will be created
  • remove attributes, which already has been migrated to sensors
  • add troubleshooting section
  • make use of terminology tooltips
    • [ ] needs #35294

Type of change

  • [x] 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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • [x] 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.
  • [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Updated documentation for the AVM Smart Home integration, including new sections for Plugs, Shutter Drivers, Templates, Thermostats, and Sensors.
  • Bug Fixes
    • Clarified and expanded attributes for various devices, ensuring accurate representation in the documentation.
  • Documentation
    • Improved organization and clarity of the integration documentation to reflect recent rebranding and categorization of supported devices.

mib1185 avatar Oct 19 '24 16:10 mib1185

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit 8fd53da5ebf746a74454a3c8c500b846e9297feb
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/671b34d1f6a4a500081a8252
Deploy Preview https://deploy-preview-35293--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.

netlify[bot] avatar Oct 19 '24 16:10 netlify[bot]

📝 Walkthrough

Walkthrough

The changes in the fritzbox.markdown file involve a comprehensive update to the documentation for the AVM Smart Home integration in Home Assistant. The updates include a rebranding from AVM FRITZ!DECT to AVM Smart Home, a reorganization of device categories, and the addition of new sections for various device types such as plugs, shutter drivers, and thermostats. The documentation has been enhanced for clarity, with expanded attributes for devices and updated links in the tested devices section.

Changes

File Change Summary
source/_integrations/fritzbox.markdown - Updated title and description for rebranding to AVM Smart Home.
- Added new sections: "Plugs," "Shutter drivers," "Templates," "Thermostats," and "Troubleshooting."
- Reorganized device categories and clarified attributes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant AVMSmartHome

    User->>HomeAssistant: Request integration setup
    HomeAssistant->>AVMSmartHome: Fetch device categories
    AVMSmartHome-->>HomeAssistant: Return device categories (Plugs, Shutter drivers, etc.)
    HomeAssistant-->>User: Display integration options
    User->>HomeAssistant: Select device type
    HomeAssistant->>AVMSmartHome: Configure selected device
    AVMSmartHome-->>HomeAssistant: Confirm configuration
    HomeAssistant-->>User: Integration successful

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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

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

coderabbitai[bot] avatar Oct 19 '24 16:10 coderabbitai[bot]

preview at https://deploy-preview-35293--home-assistant-docs.netlify.app/integrations/fritzbox/

mib1185 avatar Oct 22 '24 09:10 mib1185