documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Add a migration guide for each major release

Open milesfrain opened this issue 4 years ago • 2 comments

For each major release it would be nice to have a document describing:

  • Breaking changes in the compiler (could simply be an excerpt from release notes).
  • New compiler features since the previous major release (just copy all relevant snippets from the minor release notes).
  • Breaking changes in core libraries.
  • Breaking changes in contrib libraries.

@JordanMartinez has a nice 0.14 guide. I think that should live in this docs repo.

Maybe we create a "What's New" (inspired by F#'s docs) folder in this repo.

The closest thing we currently have are some scattered guides in the historical folder.

milesfrain avatar Jan 06 '21 21:01 milesfrain

Agreed 👍 I don’t think we should copy stuff directly from compiler release notes, but rather summarise in a way that’s most helpful to people who don’t care about the details and just want to get their code updated as quickly as possible (as Jordan has done in the existing 0.14 doc).

hdgarrood avatar Jan 06 '21 21:01 hdgarrood

Halogen has this as well:

https://github.com/purescript-halogen/purescript-halogen/tree/master/docs/changelog

thomashoneyman avatar Jan 06 '21 21:01 thomashoneyman