-
Notifications
You must be signed in to change notification settings - Fork 759
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
Update readmes and examples #3611
Conversation
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.
Thanks for tackling 🙂! This is touching already so many code lines, I will take this in, hope that's ok (but I don't see any downsides also on second thought).
Please then just do eventual subsequent work in follow-up PRs! Thanks! 🙏
The only thing to note is that there is one remaining breaking change that is not yet merged (#3589). So that PR should also include an update to the |
Ah, yeah, ok, I think there are just plently of areas in the docs where there are still some updates needed. Guess this just generally needs a good final look at the end. 🙂 (but I think it's likely ok to do semi-structured updates in between, not sure if even possible to do in a super-consistent way) |
The goal of this change is to update the package READMEs to reflect the latest changes to the examples files that are being embedded in them, and also to check and update the READMEs with more examples and details where necessary to document newly breaking changes to packages.