docs: improve network usage instructions #941
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
ctian1
reviewed
Jun 18, 2024
| @@ -17,8 +17,8 @@ SP1_PROVER=network SP1_PRIVATE_KEY=... RUST_LOG=info cargo run --release | |||
|
|
|||
| - `SP1_PROVER` should be set to `network` when using the prover network. | |||
|
|
|||
| - `SP1_PRIVATE_KEY` should be set to your [private key](#key-setup). You will need | |||
| to be using a [permissioned](#get-access) key to use the network. | |||
| - `SP1_PRIVATE_KEY` should be set to your [private key](./setup.md#key-setup). You will need | |||
There was a problem hiding this comment.
These links should be ./setup I think: https://docs.succinct.xyz/prover-network/setup
You can run mdbook locally to test, check readme
There was a problem hiding this comment.
I tested them, they're correct.
| @@ -6,30 +6,43 @@ Succinct [has been building](https://blog.succinct.xyz/succinct-network/) the Su | |||
|
|
|||
| ## Get access | |||
|
|
|||
| Currently the network is permissioned, so you need to gain access through Succinct. After you have completed the key setup below, you can submit your address in this [form](https://docs.google.com/forms/d/e/1FAIpQLSd-X9uH7G0bvXH_kjptnQtNil8L4dumrVPpFE4t8Ci1XT1GaQ/viewform) and we'll contact you shortly. | |||
| **[FILL OUT THIS FORM](https://forms.gle/rTUvhstS8PFfv9B3A)** to gain access to the Succinct | |||
There was a problem hiding this comment.
IMO this was better as it was before
There was a problem hiding this comment.
@ratankaliani said that it was too hard to find the form
ctian1
approved these changes
Jun 18, 2024
mattstam
force-pushed
the
mattstam/docs-network-improve
branch
from
f9f7c75
to
5696531
Compare
mattstam
force-pushed
the
mattstam/docs-network-improve
branch
from
5696531
to
ead6346
Compare
mattstam
force-pushed
the
mattstam/docs-network-improve
branch
from
ead6346
to
04b03fa
Compare
erabinov
pushed a commit
that referenced
this pull request
Jun 18, 2024
erabinov
pushed a commit
that referenced
this pull request
Jun 18, 2024
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.
Clarify the instructions to using
castand getting whitelisted.