vNext: Apply review feedback on the user documentation - #518
Merged
Merged
Conversation
Drop the policy that closes every time out and cannot connect issue. The cloud route now hands out the encryption key, which removes the main cause behind that policy, and the troubleshooting page covers the network causes. Corrections from review: - Entity IDs are chosen by Home Assistant, not by the integration. Say so in entities.md, automation-examples.md and the Device Name option. - External temperature and humidity sensors only change what the climate entity shows. Say so in entities.md and the README, as configuration.md already did. - Explain in configuration.md that the cloud login token is stored in the entry and reused at every load, and that only a failing token triggers a new login through reauthentication. YAML entries reuse it too. Fix the troubleshooting entry that claimed a login happens at every setup. - Format the "devices you do not pick are removed" note as a warning block. - Tell users to open an issue when a device answers a property that has no entity yet. - Tone down "every feature the remote has" and drop the comparison with the Home Assistant 2026.8 core integration.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Follow-up on the documentation split in #517, based on review feedback on the user docs.
Issue policy removed
The "TimeOut / Cannot connect issues will be closed" text is gone from the README and from
docs/troubleshooting.md. The cloud route now hands out the encryption key, which removes the main cause behind that policy. The network causes stay covered by the checks on the troubleshooting page, and "How to report a bug" now points to those checks first.Corrections
entities.md,automation-examples.mdand the Device Name option inconfiguration.md.configuration.mdsaid this already;entities.mdand the README now say it too.configuration.mdnow explains that the login token is stored in the entry and reused at every load, that only a failing token triggers reauthentication, and that YAML entries reuse it as well. Checked against__init__.py(MQTT transport built from the storeduid,tokenandregion,MqttConnectErrorraisesConfigEntryAuthFailed) andconfig_flow.py(YAML import reuses the token of a matching entry). The troubleshooting entry that claimed a login at every setup is corrected.> [!WARNING]block in both places.Checks