Update README to v4 - #2889
Conversation
| > [!WARNING] | ||
| > This branch contains version 4 of Parcels which is in active development. See `v3-support` to see v3 or the tags to browse stable versions of Parcels. | ||
|
|
There was a problem hiding this comment.
Are we still maintaining the v3-support branch?
I think it would be a good idea at least until we get more user feedback.
There was a problem hiding this comment.
Yes, I think we do keep the v4-support branch. But perhaps not as a warning - I'll change it to an INFO message
| ### Further information | ||
|
|
||
| See [parcels-code.org](http://parcels-code.org/) for further information about [installing](https://docs.parcels-code.org/en/latest/installation.html) and [running](https://docs.parcels-code.org/en/latest/documentation.html) the Parcels code, as well as extended [documentation](https://docs.parcels-code.org/en/latest/reference.html) of the methods and classes. | ||
| See [parcels-code.org](http://parcels-code.org/) for further information about [installing](https://docs.parcels-code.org/en/stable/user_guide/getting_started/installation.html) and [running](https://docs.parcels-code.org/en/stable/user_guide/index.html) the Parcels code, as well as extended [API reference](https://docs.parcels-code.org/en/stable/reference/parcels/index.html) of the methods and classes. |
There was a problem hiding this comment.
I have now finished reconfiguring RTD - so we have the latest tag again.
latest- builds offmainstable- builds off the latest release
I think we should point everything in README's and in code to the latest tag, which is now also the default version in the docs
There was a problem hiding this comment.
OK, but if the (default) documentation builds off main, while most users will install the latest release - don't we run the risk that the documentation doesn't (entirely) align with the code users have.
Or is that the reason why we "freeze" the API, so that from a user perspective nothing changes until the next release?
Co-authored-by: Nick Hodgskin <36369090+VeckoTheGecko@users.noreply.github.com>
2 participants
Description
This PR updates the links in README.md to v4. it also aligns some of the text with that on https://docs.parcels-code.org/en/stable/index.html
Checklist
mainfor normal development,v3-supportfor v3 support)AI Disclosure
None