Make module docs more change/deletion proof than it is now #170
Description
To deal with
1.2 Previous PR links
Yes, links to the Wiki in previous PRs will unfortunately break after a rename since the old Wiki pages no longer exist. This is a limitation of the current implementation.
and
2.3 Wiki and migration documentation
You're right that the Wiki and CHANGELOG become inaccessible immediately after decommissioning. This creates a challenge for providing migration instructions to users but was a conscious design decision of this project to allow for keeping the Wiki up-to-date with formatting/UI updates and other edge cases.
I'll recommend you try to push docs not only to Wiki, but alongside module too in some .md file and point PRs not only to wiki but to this .md file using commit reference, not tag
Originally posted by @MaxymVlasov in #168
Main idea: make able to investigate that was done in abandoned a few years ago module. What was changed in it and so on. Having text from it changelog also could help to find how this module named now etc., or provide migration notes without requirement to maintain any standalone file in wiki/git/etc just for migration notes after you'll remove/rename module.
You're not always able to babysit all downstream module users - there 100% will be some team that will not update anything for years, and then will ask you to migrate over 5 breaking releases at once, which easily can include module splitting, moved {} blocks and other funny stuff.