Hi, everybody knows that breaking changes happens often. Today when something doesn’t work on your home assistant you have three solutions :
1 - consult the latest release notes (but in which one you will find the breaking change ? I mean it has been broken with 0.116 , 0.117 or 0.118 ? )
2 - You read again the documentation with the hope to find the difference with your deprecated configuration.
3 - You go directly to github to see what happens to your favorite integration. (warrior way)
Well I think that we could gain a lot of time if the last breaking changes and last little change which impact the way the integration work should be logged in the documentation of the integration.
To be precise it means that an optimization would not be logged (it doesn’t change the way your configure your integration), but a change in the way you can declare the integration would be logged.
What I imagine is a section in the bottom of each integration documentation page which reference the lastest breaking changes (in the same way that it is indicated in each release notes).
There is just the version numbers of HA which are related to a breaking change.
Like in release notes, these are collapsed text block : when you click on the version number you can consult the detail.
Example for the KNX integration documentation :