Documentation of how to switch from one version to the next

[c4s]

On every new release important information is floating around the forum of what we have to take care of when switching from one version of PB to the newest. This can easily be missed and thus make upgrading much harder.

My proposal: There should be a documentation of how to properly upgrade our source code to the newest version. It can (or even should) be really short like:

from 5.10 to 5.11
---------------------
- SortStructuredArray(): Change sort type from e.g. #PB_Sort_Long to #PB_Long
- etc.

from 5.11 to 5.20
---------------------
- CreateImage(): Move #PB_Image_Transparent flag to the new 'BackColor' parameter
- DisplaySolidSprite(): Replaced with 'Color' parameter for DisplayTransparentSprite()
- DisplayRGBFilter(): Can be replaced with a zoomed sprite with color
- etc.

edit: fixed typos etc.

[PMV]

This information is included in the Changelist-History,
but yes ... sometimes it is incomplete for some
smaller, but very important changes.

[c4s]

I do see your point but still think that this feature request is justified, simply because the changelog can be pretty overwhelming and - as you've said - small (but important) details are most times not properly mentioned.

I would like this documentation to be as straight-forward as possible so that I know exactly want needs to be done to successfully upgrade my source code from one version to the next one.
So if I e.g. want to upgrade from 5.00 to 5.20 I'll immediately see the changes I have to implement without looking through the whole list of changelogs, possibly numerous forum threads and help pages...

[RobKiwi]

As a relative beginner, I do strongly agree with this idea...