docs: add example command for sp1up with GitHub token #1927
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
Add an example command showing how to use sp1up with a GitHub token to resolve rate-limiting issues. This makes the installation documentation more complete and user-friendly by demonstrating the correct syntax for using the --token flag.
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.
Motivation
The installation documentation had a TODO comment indicating that an example command was needed to demonstrate how to use the
sp1upcommand with a GitHub token. This example is important for users who encounter rate-limiting issues during installation, as it shows them the correct syntax for using the--tokenflag.Without this example, users might struggle to understand how to properly format the command when they encounter rate-limiting issues, leading to a potentially frustrating installation experience.
Solution
Added a clear example command showing how to use the
sp1upcommand with a GitHub token:bash
sp1up --token ghp_YOUR_GITHUB_TOKEN_HERE
PR Checklist