docs: update blobstream to SP1 version from Blobstream X #1680
Conversation
WalkthroughThe document revisions focus on enhancing clarity and conciseness for deploying SP1 Blobstream. Key sections have been streamlined to emphasize essential actions while removing redundancies. The overall structure now guides developers more effectively, improving user-friendliness and accessibility across various technical backgrounds. Changes
Possibly related PRs
Suggested labels
Poem
Tip Announcements
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (7)
Files skipped from review due to trivial changes (1)
Additional context usedLanguageTool
Markdownlint
Additional comments not posted (7)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
developers/blobstream-x-deploy.md (2)
13-23: Consider mentioning branch or tag checkout.To ensure users are working with the correct version, consider adding a note about checking out a specific branch or tag after cloning the repository.
cd sp1-blobstream + # Optionally, checkout a specific branch or tag + git checkout <branch-or-tag>
25-29: Add guidance on locatingsp1-contractsandsp1-sdkversions.Consider adding a note on where to find the appropriate
sp1-contractsandsp1-sdkversions to match.a. Deploy your own SP1 Verifier from `sp1-contracts` matching your `sp1-sdk` version. + # You can find the versions in the respective repositories or documentation.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- developers/blobstream-x-deploy.md (1 hunks)
Additional comments not posted (2)
developers/blobstream-x-deploy.md (2)
9-9: Introduction is clear and concise.The purpose of the document is well-stated, providing a good overview for the reader.
31-34: Prover setup instructions are clear.The options for local and network proving are well-explained.
jcstein
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
developers/sp1-blobstream-deploy.md (2)
25-29: Consider adding more guidance for deploying a custom verifier.While the instructions mention deploying a custom SP1 Verifier, providing a link to detailed instructions or examples could be helpful for users unfamiliar with the process.
Consider adding a link to a guide or documentation on deploying a custom SP1 Verifier.
31-35: Provide context for hardware recommendations.The hardware recommendation is clear, but explaining why such specifications are necessary could help users understand the requirements better.
Consider adding a brief explanation of the computational demands of the prover to justify the hardware recommendation.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
public/audits/SP1_Blobstream_Ottersec_Audit.pdfis excluded by!**/*.pdf
Files selected for processing (4)
- .vitepress/config.ts (1 hunks)
- developers/blobstream-x-requesting-data-commitment-ranges.md (1 hunks)
- developers/celestia-node-key.md (1 hunks)
- developers/sp1-blobstream-deploy.md (1 hunks)
Files skipped from review due to trivial changes (2)
- developers/blobstream-x-requesting-data-commitment-ranges.md
- developers/celestia-node-key.md
Additional comments not posted (3)
developers/sp1-blobstream-deploy.md (1)
7-9: Introductory content is clear and concise.The introduction effectively sets the context for the document.
.vitepress/config.ts (2)
724-749: Sidebar configuration changes are accurate and consistent.The updates to text labels and links for SP1 Blobstream align with the PR objectives and improve clarity.
Line range hint
1-723: No changes outside the sidebar configuration.The rest of the file remains unchanged and is consistent with previous configurations.
Also applies to: 750-750
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- .vitepress/config.ts (1 hunks)
- developers/blobstream-contracts.md (1 hunks)
- developers/blobstream-proof-queries.md (1 hunks)
- developers/blobstream.md (2 hunks)
- developers/sp1-blobstream-deploy.md (1 hunks)
Files skipped from review due to trivial changes (2)
- developers/blobstream-contracts.md
- developers/blobstream-proof-queries.md
Files skipped from review as they are similar to previous changes (1)
- developers/sp1-blobstream-deploy.md
Additional comments not posted (4)
developers/blobstream.md (3)
30-33: LGTM!The new section "Implementations of Blobstream" provides a clear structure for users to understand the different variants of Blobstream available.
The code changes are approved.
65-74: LGTM!The new section "What is SP1 Blobstream?" provides essential information about SP1 Blobstream and directs users to related deployment documentation.
The code changes are approved.
Line range hint
708-733: LGTM!The new items under "SP1 Blobstream" in the sidebar configuration provide direct access to relevant audit resources and deployment documentation for SP1 Blobstream.
The code changes are approved.
.vitepress/config.ts (1)
708-733: LGTM!The new items under "SP1 Blobstream" in the sidebar configuration provide direct access to relevant audit resources and deployment documentation for SP1 Blobstream.
The code changes are approved.
Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- developers/blobstream.md (2 hunks)
- developers/sp1-blobstream-deploy.md (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- developers/blobstream.md
- developers/sp1-blobstream-deploy.md
Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>
* docs: update to SP1 docs * chore: correct code groups * chore: correct code groups * chore: correct code groups * chore: add bindings links * chore: nits * chore: nits
Overview
PREVIEW
New menu
Collapsed new menu
TODO:
blobstream-contracts.mdto "Blobstream X" section https://docs.celestia.org/developers/blobstream-contractsblobstream-offchain.mdto "Blobstream X" section https://docs.celestia.org/developers/blobstream-offchainblobstream-proof-queries.md"Blobstream X" section https://docs.celestia.org/developers/blobstream-proof-queriesblobstream-x-requesting-data-commitment-ranges.mdto "Blobstream X" section https://docs.celestia.org/developers/blobstream-x-requesting-data-commitment-rangesblobstream.mdto "Blobstream X" section https://docs.celestia.org/developers/blobstreamAdds SP1 Blobstream page
Summary by CodeRabbit
Summary by CodeRabbit