Skip to content
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

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

Open
6 of 8 tasks
ReneWerner87 opened this issue Nov 7, 2023 · 0 comments · Fixed by #2934
Open
6 of 8 tasks

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

ReneWerner87 opened this issue Nov 7, 2023 · 0 comments · Fixed by #2934

Comments

@ReneWerner87
Copy link
Member

ReneWerner87 commented Nov 7, 2023

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.
@ReneWerner87 ReneWerner87 changed the title 📒 [v3 Maintenance]: Consolidate and Document Core Changes in v3 for Release Notes and Documentation Update 📒 [v3 Maintenance]: Consolidate and Document Core Changes in v3 Nov 7, 2023
@ReneWerner87 ReneWerner87 added this to the v3 milestone Nov 7, 2023
@ReneWerner87 ReneWerner87 self-assigned this Mar 25, 2024
@ReneWerner87 ReneWerner87 linked a pull request Mar 25, 2024 that will close this issue
5 tasks
@ReneWerner87 ReneWerner87 reopened this Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant