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.

Sign up for GitHub

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

Jump to bottom

Write a proper migration guide for the v4 -> v5 transition. #1168

Open
navaronbracke opened this issue Sep 4, 2024 · 0 comments
Open

Write a proper migration guide for the v4 -> v5 transition. #1168

navaronbracke opened this issue Sep 4, 2024 · 0 comments
Assignees
@navaronbracke
Labels
documentation Improvements or additions to documentation

Comments

@navaronbracke
Copy link
Collaborator

We currently only have mentions of breaking changes in v5 in the changelog.

We should have a migration guide (can be a markdown document) to help users with breaking changes.
Preferably we also put this in a docs folder, so that future migration guides can also be put there.

We should provide a mention of the migration guide in the readme.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@navaronbracke navaronbracke

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@navaronbracke