Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated outdated link in blobstream-rollups.md #1761

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

pucedoteth
Copy link
Contributor

@pucedoteth pucedoteth commented Oct 22, 2024

<--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before submitting your
first PR.
-->

Overview

<--
This pull request improves documentation of Celestia by adding right docs links to the readers so avoid any miss-understanding

-->

Summary by CodeRabbit

  • Documentation
    • Restructured and enhanced the guide on Blobstream rollups, clarifying its role in data availability for EVM chains.
    • Expanded the "Concepts" section to detail two methods for building Blobstream rollups: "Blob share commitment" and "Sequence of spans."
    • Provided insights on optimistic and zk-rollups, including their implications and requirements for data referencing.
    • Concluded with a recommendation for the "Sequence of spans" method due to its advantages in proof size and flexibility.

Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes involve a comprehensive restructuring and enhancement of the documentation for Blobstream rollups. The introduction clarifies the role of Blobstream in data availability for EVM chains, while the "Concepts" section elaborates on two methods for building Blobstream rollups: "Blob share commitment" and "Sequence of spans." Each method is detailed with its proof requirements and limitations. The document also discusses optimistic and zk-rollups in relation to these methods, concluding with a preference for the sequence of spans due to its advantages.

Changes

File Change Summary
how-to-guides/blobstream-rollups.md Restructured and enhanced content on Blobstream rollups, including detailed explanations of two primary methods, optimistic and zk-rollups, and a conclusion advocating for the sequence of spans method.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • jcstein
  • rach-id

🐰 In the land of code, where rollups play,
Blobstream's magic brightens the way.
With spans and proofs, we craft and refine,
Data's safe journey, oh how it will shine!
So hop along, let the knowledge unfurl,
In the world of EVM, let's give it a whirl! 🌟


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
🪧 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>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
how-to-guides/blobstream-rollups.md (1)

61-61: Consider using a versioned link instead of main branch.

Links to the main branch can break when repository structure changes. Consider linking to a specific version or tag for better stability.

-[data square layout](https://github.com/celestiaorg/celestia-app/blob/main/specs/src/data_square_layout.md).
+[data square layout](https://github.com/celestiaorg/celestia-app/blob/v1.0.0-rc2/specs/src/data_square_layout.md).
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9da6f8f and 2414245.

📒 Files selected for processing (1)
  • how-to-guides/blobstream-rollups.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
how-to-guides/blobstream-rollups.md (2)

Line range hint 1-24: Technical content looks good!

The documentation provides clear and accurate explanations of the different approaches to implementing Blobstream rollups, with appropriate code examples and technical details.

Also applies to: 32-38, 61-61


Line range hint 1-24: Documentation structure is excellent!

The document is well-organized with:

  • Clear section hierarchy
  • Consistent formatting
  • Balanced mix of technical details and explanations
  • Helpful comparison of different approaches with pros and cons

@jcstein jcstein merged commit 9bf4a09 into celestiaorg:main Oct 23, 2024
2 checks passed
Copy link

gitpoap-bot bot commented Oct 23, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Celestia Contributor:

GitPOAP: 2024 Celestia Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants