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

Write docs for transition to new crate structure #290

Closed
4 tasks done
thomaseizinger opened this issue Apr 11, 2023 · 6 comments
Closed
4 tasks done

Write docs for transition to new crate structure #290

thomaseizinger opened this issue Apr 11, 2023 · 6 comments
Milestone

Comments

@thomaseizinger
Copy link
Contributor

thomaseizinger commented Apr 11, 2023

Created as a result of #272 (review).

This issue is to collect what needs to be done before we can cut the first release:

Tasks

@thomaseizinger
Copy link
Contributor Author

README needs to be updated too.

@thomaseizinger thomaseizinger added this to the v0.19 milestone May 2, 2023
@vmx

This comment was marked as resolved.

@thomaseizinger
Copy link
Contributor Author

Where do you think would this migration docs best be written? In the README? Normally I'd add it to the changelog but that one is auto-generated here, right?

@vmx
Copy link
Member

vmx commented May 31, 2023

Normally I'd add it to the changelog but that one is auto-generated here, right?

The changelog. I'd call it "semi-autogenerated". So what I would do is, creating the new entries as outlined in the RELEASE.md and then manually tweak it. Please note that I've tried to make it clearer (and also updated the instructions for the generation) at #314.

@thomaseizinger
Copy link
Contributor Author

@vmx all items in here now have an open PR. Do you mind having a look and see if that is sufficient documentation so we can cut a release?

@thomaseizinger
Copy link
Contributor Author

Closing this because all tasks are completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants