Add a migration guide for each major release · Issue #370 · purescript/documentation · GitHub
Skip to content

Add a migration guide for each major release #370

Open

Description

@milesfrain

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.

Activity

  1. hdgarrood commented on Jan 6, 2021

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

  2. thomashoneyman commented on Jan 6, 2021

    @thomashoneyman
    Member
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions