feat: add docs for standalone binaries and Go client #56
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
Member
alanshaw
commented
Dec 11, 2023
alanshaw
commented
|
Leaving here page for help looking into deployment https://41527c5a.w3up-website-staging.pages.dev/docs/go-w3up/ |
vasco-santos
approved these changes
Dec 12, 2023
| 1. [Loading your private key and proofs](#load-priviate-key-and-proofs) | ||
| 1. [Uploading a CAR file](#upload-a-car) | ||
|
|
||
| ## Install |
There was a problem hiding this comment.
probably we should mention to install npx/npm
There was a problem hiding this comment.
It does say "Install Node.js" where it is needed below. I wanted to create a go equivalent so you'd not need to so would prefer to not mention here!
| ``` | ||
|
|
||
| <Callout type="warning"> | ||
| Maximum upload size is 4,261,412,864 bytes (around 4GB). To upload CAR files larger than this, please use the [sharding utility](https://github.com/web3-storage/go-w3up/blob/main/car/sharding/sharding.go) to split the CAR into multiple shards. |
There was a problem hiding this comment.
Suggested change
| Maximum upload size is 4,261,412,864 bytes (around 4GB). To upload CAR files larger than this, please use the [sharding utility](https://github.com/web3-storage/go-w3up/blob/main/car/sharding/sharding.go) to split the CAR into multiple shards. | |
| Maximum upload size for a chunk is 4,261,412,864 bytes (around 4GB). To upload CAR files larger than this, please use the [sharding utility](https://github.com/web3-storage/go-w3up/blob/main/car/sharding/sharding.go) to split the CAR into multiple shards. |
I think it would be good to be explicit as the chunk does not represent what an user is able to upload as part of a dag
There was a problem hiding this comment.
just read below, and I think it even is nicer then to include chunk detail
Co-authored-by: Vasco Santos <[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.