feat: update blobstream-x-deploy.md

[jcstein]

Implements feedback from Succint

Overview

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

Summary by CodeRabbit

• New Features
  • Introduced a new step to skip if the Succinct Gateway already exists, enhancing the deployment process.
  • Added instructions for running a local prover post-deployment, improving user experience for developers.

[coderabbitai]

Walkthrough

The recent update enhances the deployment process by intelligently recognizing existing Succinct Gateway components on the blockchain, thereby skipping redundant steps. Additionally, it introduces guidance for setting up a local prover post-deployment, streamlining the overall setup for developers and ensuring a smoother integration with the blockchain environment.

Changes

Files	Change Summary
developers/.../blobstream-x-deploy.md	Added steps to skip Succinct Gateway setup if it exists; introduced section on running a local prover.

🐰✨
In the realm of code where the data streams flow,
A clever rabbit hopped, making the blockchain glow.
"Skip what's done," it whispered with glee,
"A prover local, as swift as can be."
With every hop and every byte,
It made the developers' day ever so bright.
🌟🐾

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-02-29 14:25 UTC

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between fa42454 and c401fd5.

Files selected for processing (1)

• developers/blobstream-x-deploy.md (1 hunks)

Additional comments: 2

developers/blobstream-x-deploy.md (2)

• 7-9: The addition of the step to check for an existing "Succinct Gateway" before proceeding with deployment is a practical improvement. It helps in optimizing the deployment process by avoiding unnecessary steps. However, ensure that the link provided (https://docs.succinct.xyz/platform/onchain-integration#succinctgateway) is accessible and contains up-to-date information regarding the deployed SuccinctGateway contracts. It might also be beneficial to include a brief guide or command snippet on how to verify the existence of the "Succinct Gateway" on the chain for clarity and completeness.
• 19-22: Adding a section on running a local prover after deploying contracts is a valuable addition, as it emphasizes the importance of verification post-deployment. This step ensures that the deployed contracts are functioning as expected. It's crucial, however, to ensure that the link to ./requesting-data-commitment-ranges.md#local-proving is correct and leads to a detailed guide on how to run a local prover. If this document is part of a larger documentation structure, consider adding a brief explanation or prerequisites section to help readers prepare for this step, especially if it requires specific setup or configurations.