-
Notifications
You must be signed in to change notification settings - Fork 380
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
chore: fix incorrect quotation marks #1843
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThis pull request primarily focuses on typographical refinements across several Celestia documentation files. The changes predominantly involve replacing straight quotation marks with curly quotes in various sections, particularly in headers, terms, and descriptions. While most modifications are cosmetic, the Arbitrum integration guide introduces a new configurable fallback mechanism for data availability and a Changes
Sequence DiagramsequenceDiagram
participant Sequencer
participant Blobstream
participant Arbitrum Node
participant Ethereum
Sequencer->>Arbitrum Node: Send data pointer
Arbitrum Node->>Blobstream: Verify data root
alt Data Root Verified
Arbitrum Node-->>Sequencer: Proceed with message
else Data Root Not Verified
Arbitrum Node->>Ethereum: Use Ethereum Fallback
end
Poem
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
community/modular-meetup-toolkit.md
(4 hunks)how-to-guides/arbitrum-integration.md
(1 hunks)how-to-guides/bridge-node.md
(2 hunks)how-to-guides/ethereum-fallback.md
(1 hunks)how-to-guides/light-node.md
(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- how-to-guides/light-node.md
- how-to-guides/ethereum-fallback.md
- community/modular-meetup-toolkit.md
- how-to-guides/bridge-node.md
@@ -90,7 +90,7 @@ The [@celestiaorg/nitro](https://github.com/celestiaorg/nitro) integration | |||
[uses the same fallback mechanism](https://github.com/celestiaorg/nitro/blob/f01968eb3d4e19329e9c92b050e98a8e5772f1f2/arbnode/batch_poster.go#L845-L857). | |||
|
|||
[More information can be found on the Ethereum fallback mechanisms for Celestia](./ethereum-fallback.md), | |||
which enables Ethereum L2s (or L3s) to “fall back” to using Ethereum | |||
which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum |
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.
Replace full-width quotation marks with standard English quotes
The current change uses full-width quotation marks (") which are typically reserved for CJK text. For English documentation, this could cause inconsistent text alignment and searchability issues.
Apply this change:
-which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum
+which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum
Or if curly quotes are preferred:
-which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum
+which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum | |
which enables Ethereum L2s (or L3s) to "fall back" to using Ethereum |
Incorrect use of quotation marks can lead to certain editors failing to accurately render text content, which may result in garbled output or other formatting issues that could confuse readers.
Summary by CodeRabbit
New Features
VerifyAttestation
capability in Arbitrum node software for data root verification.Bug Fixes
Documentation