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

Check readme examples #221

Open

Pfeil opened this issue Feb 13, 2025 · 0 comments

Labels

documentation good first issue

Member

Pfeil commented Feb 13, 2025 •

edited

Loading

The readme examples are partially outdated. For example, it still shows the addContent method.

This should be fixed and the examples should be checked
Consider some automated workflow for the examples. The Readme is a bit bloated with examples anyway. We should consider making tests out of them (if they aren't) and link to them instead. This will shorten the readme. We could keep one representational example in the readme so the user gets an immediate idea of how this will work.

Side note: I added a transition guide in the release notes of v2.0.0 regarding the renamed addContent function.

Pfeil added documentation good first issue labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment