-
Notifications
You must be signed in to change notification settings - Fork 374
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
Conversation
WalkthroughThe 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
Possibly related PRs
Suggested labels
Suggested reviewers
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 (
|
There was a problem hiding this 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
📒 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
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 Celestia Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
<--
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