docs: add migration guide for libp2p@0.46.x #1883
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds migration guide detailing breaking changes in libp2p@0.46.x
maschad
reviewed
Jul 20, 2023
|
|
||
| **Before** | ||
|
|
||
| ```js |
There was a problem hiding this comment.
Going forward we should really utilize Typescript examples so that they can be compiled and thus reduce the probability of doc errors.
There was a problem hiding this comment.
Probably, though it'll involve a lot of boilerplate imports.
There was a problem hiding this comment.
True, but otherwise we lose the benefit of the type safety. Perhaps we can begin with #1777 as a precedent.
I've omitted it here because it's not a breaking change, though I suppose it wouldn't hurt to include new features too. |
maschad
requested changes
Jul 27, 2023
Co-authored-by: Chad Nehemiah <chad.nehemiah94@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds migration guide detailing breaking changes in libp2p@0.46.x