docs: simplify the readme js code example #1174
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
its better if we direct folks to the docs or the workshopper rather than try and explain it all here. License: MIT Signed-off-by: Oli Evans <[email protected]>
| See https://web3.storage/docs/w3up-client for a guide to using the js client for the first time. | ||
|
|
||
| For an interactive command line adventure into the using w3up check out `learnyouw3up` here https://github.com/web3-storage/learnyouw3up |
There was a problem hiding this comment.
my main concern is that we need to make sure to keep this updated, which feels more difficult compared to within the README.
I would personally prefer to have examples folder, and tests for them so that they keep updated when PRs land
There was a problem hiding this comment.
i will remove the link to learnyouw3up when it is not longer maintained. Right now it's our best documentation.
gobengo
pushed a commit
that referenced
this pull request
Nov 28, 2023
its better if we direct folks to the docs or the workshopper rather than try and explain it all here. License: MIT Signed-off-by: Oli Evans <[email protected]>
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.
its better if we direct folks to the docs or the workshopper rather than try and explain it all here.
License: MIT