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.

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

[FEATURE] Add a "migration guide" in documentation #843

Open
sarthakpati opened this issue Apr 3, 2024 · 0 comments
Open

[FEATURE] Add a "migration guide" in documentation #843

sarthakpati opened this issue Apr 3, 2024 · 0 comments
Assignees
@VukW @scap3yvt
Labels
documentation Improvements or additions to documentation

Comments

@sarthakpati
Copy link
Collaborator 

          I vote to move to `0.1.0` after this PR gets merged rather than `0.0.20`, since it is going to be a pretty big API change.

Originally posted by @sarthakpati in #818 (comment)

There needs to be migration guide in the documentation for folks moving from 0.0.XX to 0.1.0. This should include at least 2 items:

  1. Details about how to use the new configuration structure (after Updated version checking mechanism #841).
  2. Details about using the new CLI API.
@sarthakpati sarthakpati added documentation Improvements or additions to documentation enhancement New feature or request and removed enhancement New feature or request labels Apr 3, 2024
@sarthakpati sarthakpati mentioned this issue May 1, 2024
Open
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@VukW VukW

@scap3yvt scap3yvt

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@VukW @sarthakpati @scap3yvt