-
Notifications
You must be signed in to change notification settings - Fork 15
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 web docs page explaining the API changes and how to update. #144
Conversation
Alongside this perhaps we should bump the package number here: Line 4 in ac4c14f
And perhaps a change to switch to semantic versioning? |
We could, but I am not sure it carries much meaning since we haven't updated it so far... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jatkinson1000 this is amazing. Thanks for doing this. It's really clear what the changes are and how to upgrade to the new API. Super 🚀
Thanks @TomMelt I will wait for Joe to have a final look over #143 and then merge this after that goes in. I'm collating a list of users to email so please add any users you are aware of that I need to email here @dorchard @jwallwork23:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very clear, nice! One optional minor comment.
Minor Aesthetic changes to the webpage and added a note to the README to highlight until v1.0.0. |
This PR adds a web docs page explaining the API changes and how to update following the breaking changes of #136 and #143
This can then be sent to known users to help them update.