-
Notifications
You must be signed in to change notification settings - Fork 270
superchain-bridges #695
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
superchain-bridges #695
Conversation
WalkthroughThe overall change involves updating references and hyperlinks across various documentation files to reflect a new naming convention. Specifically, the term "Optimism Bridge UI" has been replaced with "Superchain Bridges UI" to align with updated branding and functionality. This change ensures consistency across the documentation and helps users navigate the correct interfaces and tools. Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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
Out of diff range and nitpick comments (21)
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx (4)
Line range hint
16-16
: Add a comma for clarity.- ...ERC-20 tokens with the Optimism SDK](./cross-dom-bridge-erc20). + ...ERC-20 tokens with the Optimism SDK](./cross-dom-bridge-erc20).
Line range hint
31-31
: Consider a more concise phrasing.- ...contract must implement this interface in order to be bridged using the Standard Bridge system. + ...contract must implement this interface to be bridged using the Standard Bridge system.
Line range hint
52-52
: Consider a more concise phrasing.- ...the OP Sepolia network to your wallet in order to follow this tutorial. + ...the OP Sepolia network to your wallet to follow this tutorial.
Line range hint
122-122
: Consider an alternative phrasing to avoid overuse of "exactly".- ...for the token you just created! This is exactly what this tutorial was meant to demonstrate. + ...for the token you just created! This is precisely what this tutorial was meant to demonstrate.pages/stack/explainer.mdx (17)
Line range hint
29-29
: Consider a shorter alternative to "due to the fact that" for conciseness.- This is largely due to the fact that a majority of web applications are unable to be run onchain due to scalability constraints inherent to the current state of blockchain technology. + This is largely because most web applications cannot run onchain due to scalability constraints inherent to the current state of blockchain technology.
Line range hint
47-47
: Add a comma for clarity.- In this world where most applications go onchain more data becomes cryptographically verifiable. + In this world where most applications go onchain, more data becomes cryptographically verifiable.
Line range hint
55-55
: "Architect" is a noun. Use "design" or "devise" instead.- we think a clear picture for how to architect a truly scalable blockchain is beginning to come into view. + we think a clear picture for how to design a truly scalable blockchain is beginning to come into view.
Line range hint
76-76
: Avoid using a colon before a series introduced by a preposition.- By using the shared source of truth it is possible to: a) enforce standard security models across all chains; and b) remove the requirement that chain deployments require a new set of validators because each L2 chain uses L1 consensus. + By using the shared source of truth it is possible to a) enforce standard security models across all chains and b) remove the requirement that chain deployments require a new set of validators because each L2 chain uses L1 consensus.
Line range hint
118-118
: Use "an" instead of "a" before a word starting with a vowel sound.- are required to create a initial Superchain that makes it possible to deploy and upgrade many chains with the same bridge: + are required to create an initial Superchain that makes it possible to deploy and upgrade many chains with the same bridge:
Line range hint
153-153
: Specify a number or use "many" or "numerous" for clarity.- Challengers must request attestations from a large number of chain attestors and combine these attestations into a single transaction called an attestation proof. + Challengers must request attestations from many chain attestors and combine these attestations into a single transaction called an attestation proof.
Line range hint
155-155
: Add a comma for clarity.- That means that if these chain attestors are malicious they cannot alone break the safety of withdrawals. + That means that if these chain attestors are malicious, they cannot alone break the safety of withdrawals.
Line range hint
177-177
: Use hyphens for compound adjectives.- round robin sequencing, sequencer consensus protocols, PGA ordering, or FIFO ordering. + round-robin sequencing, sequencer consensus protocols, PGA ordering, or FIFO ordering.
Line range hint
183-183
: Use a comma before "and" if it connects two independent clauses.- that withdrawals are indefinitely paused and bridge upgrades would be perpetually canceled. + that withdrawals are indefinitely paused, and bridge upgrades would be perpetually canceled.
Line range hint
191-191
: Use a hyphen for a compound adjective.- along with a very large bond. This begins a two week challenge period. + along with a very large bond. This begins a two-week challenge period.
Line range hint
214-214
: Add a comma for clarity.- overview of potential future enhancements, which when combined, addresses each one of these pain points. + overview of potential future enhancements, which, when combined, addresses each one of these pain points.
Line range hint
247-247
: Use hyphens for compound adjectives.- low latency bridging for low value state and high latency for high value state. + low-latency bridging for low-value state and high-latency for high-value state.
Line range hint
267-267
: Add a comma for clarity.- the transaction data must be submitted to L1 which has limited capacity. + the transaction data must be submitted to L1, which has limited capacity.
Line range hint
273-273
: Add a comma for clarity.- whereas on L1 every Ethereum node downloads all of the transaction data on L1. + whereas on L1, every Ethereum node downloads all of the transaction data on L1.
Line range hint
289-289
: Add a comma for clarity.- fault proof system to Rollup chains with the only difference being that additional data is derived from the chain using the hashes that are finalized in the Plasma Contract. + fault proof system to Rollup chains, with the only difference being that additional data is derived from the chain using the hashes that are finalized in the Plasma Contract.
Line range hint
315-315
: Use the base form of the verb after "to" in an infinitive phrase.- regardless of which OP Chain they are intended to enables users to avoid constantly switching their network. + regardless of which OP Chain they are intended to enable users to avoid constantly switching their network.
Line range hint
323-323
: Use a hyphen for a compound adjective.- your open source contributions may be rewarded too! + your open-source contributions may be rewarded too!
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.
lgtm - to be merged next wk
updates throughout for language and links