search

multiformats / rust-multihash

multihash implementation in Rust
https://github.com/multiformats/multihash
Other
150 stars 60 forks source link

Write docs for transition to new crate structure #290

Closed thomaseizinger closed 1 year ago

thomaseizinger commented 1 year ago

Created as a result of https://github.com/multiformats/rust-multihash/pull/272#pullrequestreview-1379200798.

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

- [x] Document how users can replace the identity hasher. Done in https://github.com/multiformats/rust-multihash/pull/289.
- [ ] https://github.com/multiformats/rust-multihash/pull/320
- [ ] https://github.com/multiformats/rust-multihash/pull/321
- [ ] https://github.com/multiformats/rust-multihash/pull/319
thomaseizinger commented 1 year ago

README needs to be updated too.

vmx commented 1 year ago

Add a note that users upgrading could define a type alias like type Multihash = multihash::Multihash<64>. See https://github.com/multiformats/rust-multihash/pull/305#issuecomment-1531296203 for more information.

thomaseizinger commented 1 year ago

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 commented 1 year ago

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 https://github.com/multiformats/rust-multihash/pull/314.

thomaseizinger commented 1 year ago

@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 commented 1 year ago

Closing this because all tasks are completed.