Skip to content

Cleanup Xiaomi Miio docs#21861

Closed
rytilahti wants to merge 2 commits into
currentfrom
janitor/xiaomi_miio/cleanup_docs
Closed

Cleanup Xiaomi Miio docs#21861
rytilahti wants to merge 2 commits into
currentfrom
janitor/xiaomi_miio/cleanup_docs

Conversation

@rytilahti
Copy link
Copy Markdown
Member

@rytilahti rytilahti commented Mar 2, 2022

Proposed change

The current xiaomi_miio documentation is very verbose in terms of what types of sensors, switches, and other entities are available. As "miio" itself is a platform supporting a wide variety of different types of devices from a variety of different vendors, it does not make sense to document each and every available device-specific detail in the homeassistant documentation.

The goal of this PR is to relieve both developers and documentation writers from the burden of keeping the information stored in the documentation in sync with the code. This (or a follow-up PR) should reorganize the docs to document the supported platforms and only document the custom services, alongside with known limitations if any.

Therefore, this cleanup PR removes the pieces of documentation that I personally consider unnecessary:

  • Documentation that is already done for standardized platforms
  • Documentation that is too specific for any given model, considering that xiaomi_miio is a platform integration much like homekit & co.

Note that this PR at places also removes information about the list of supported device models and device-specific limitations, which should be forced by the implementation. If wanted, such information (e.g., oscillation angles, available modes, ..) should be codified in a more general way (using entity descriptions?) to automatically generate documentation in the future.

Follow-up PRs will handle the following

  • Restructure the document to be based on supported platforms
  • Rewrite the intro to follow that structure instead of pointing to specific devices
  • Clean up the token extraction (mostly unnecessary for people using the cloud access, so just add a link or two for alternative approaches for manual configuration?)

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

  • 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

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

@rytilahti rytilahti requested review from bieniu and syssi as code owners March 2, 2022 00:31
@probot-home-assistant probot-home-assistant Bot added the current This PR goes into the current branch label Mar 2, 2022
@rytilahti rytilahti marked this pull request as draft March 2, 2022 00:48
@frenck frenck added the in-progress This PR/Issue is currently being worked on label Mar 22, 2022
@github-actions
Copy link
Copy Markdown

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

@github-actions github-actions Bot added the stale The PR had no activity for quite some time, and is marked as Stale label May 21, 2022
@github-actions github-actions Bot closed this May 28, 2022
@probot-home-assistant probot-home-assistant Bot removed the in-progress This PR/Issue is currently being worked on label May 28, 2022
@syssi syssi reopened this May 28, 2022
Copy link
Copy Markdown
Member

@syssi syssi left a comment

Choose a reason for hiding this comment

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

I would be happy to have this cleanup merged as first step.

@github-actions github-actions Bot closed this Jun 4, 2022
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 5, 2022
@rytilahti
Copy link
Copy Markdown
Member Author

This is still pending for feedback.

@rytilahti rytilahti reopened this Mar 8, 2023
@rytilahti rytilahti removed the stale The PR had no activity for quite some time, and is marked as Stale label Mar 8, 2023
@frenck
Copy link
Copy Markdown
Member

frenck commented Nov 24, 2023

@rytilahti From who?

@frenck
Copy link
Copy Markdown
Member

frenck commented Mar 20, 2024

Because there hasn't been any activity on this PR for quite some time now, I've decided to close it for being stale.

Feel free to re-open this PR when you are ready to pick up work on it again 👍

@frenck frenck closed this Mar 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed current This PR goes into the current branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants