Skip to content

Check readme examples #221

Description

@Pfeil

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.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions