DOC: Add page for v4-migration guide #2189
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VeckoTheGecko
commented
Sep 9, 2025
Comment on lines
+13
to
+14
| Release Notes <https://github.com/OceanParcels/Parcels/releases> | ||
| Parcels v4.0 Migration Guide <v4-migration> |
Contributor
Author
There was a problem hiding this comment.
I wasn't 100% sure where this should go. This was the best place I could think of. Other projects don't really have a standard place to put this - zarr has a dedicated page in their "user guide", uses a release notes section of their website.
| nojit | ||
| TODO | ||
| Parcels v4 Project Board <https://github.com/orgs/OceanParcels/projects/5> | ||
| Parcels v4 migration guide <../community/v4-migration> |
Contributor
Author
There was a problem hiding this comment.
Linking it as well from this page, but once v4 is released this whole "v4" section will be deleted (we probably might want to do other restructuring as well, to be decided/discussed later)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR renames the breaking changes file to be the migration guide so that its visible in the documentation website.
Once development has stabilised (or in the week leading up to the parcels event) we can flesh this out with code examples.
v4-devfor v4 changes)