META: How does the Developer upgrade guide get filled?
Hello!
So, the developer upgrade guide is currently lagging behind, with the guide for 1806 "coming soon". My guess is that the guide is being composed after the release, which needs going through the introduced changes after the fact. A more efficient system, also leading to a better and more complete guide, would be to make it a live document where breaking API changes are registered upon commit. For each braking change one could add something like
ClassName Short description of the breaking change
This would really make things easy for people writing stand-alone libraries since they can immediately see if their code is affected and how to address it. Hopefully, the overhead for the devs is not that large since breaking changes should not happen too often. Releasing the guide would amount to freezing the document upon the release of a new version of the software, sorting the list after the class name and adding a more detailed discussion of the most important changes.