Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a migration guide for each major release #370

Open
milesfrain opened this issue Jan 6, 2021 · 2 comments
Open

Add a migration guide for each major release #370

milesfrain opened this issue Jan 6, 2021 · 2 comments

Comments

@milesfrain
Copy link
Contributor

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.

@hdgarrood
Copy link
Collaborator

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).

@thomashoneyman
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants