Skip to content

📒 [v3 Maintenance]: Consolidate and Document Core Changes in v3 #2712

@ReneWerner87

Description

@ReneWerner87

Maintenance Task Description

The task is to identify and document all core changes that have been made in the beta branch for the upcoming v3 release. This includes updating the documentation to reflect these changes, providing examples for new usage patterns, and creating a migration guide if necessary.

Tasks

  • Review commit history and pull requests in the beta branch to identify all core changes since the last sync with v2.
  • Write a "What's New" markdown document in the root folder, summarizing the significant core changes. (for the release)
  • Update the documentation with the new v3 API changes and usage patterns.
  • Provide code examples that demonstrate the new features or changes in usage.
  • Create a migration guide in the docs folder for transitioning from v2 to v3, if required.

Expected Outcome

  • A "What's New" markdown document for core changes that can be used for release notes.
  • Updated v3 documentation with clear examples and migration guide for current users.

Checklist:

  • I have confirmed that this maintenance task is currently not being addressed.
  • I understand that this task will be evaluated by the maintainers and prioritized accordingly.
  • I am available to provide further information if needed.

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions