Skip to content

Conversation

cpengilly
Copy link
Contributor

create new rollups folder, update links

Copy link

netlify bot commented May 14, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit fbb332b
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/6644c2722a6dd20008d7f122
😎 Deploy Preview https://deploy-preview-692--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@cpengilly cpengilly changed the title create new directory new protocol directory May 14, 2024
@cpengilly cpengilly marked this pull request as ready for review May 14, 2024 20:59
@cpengilly cpengilly requested a review from a team as a code owner May 14, 2024 20:59
@cpengilly cpengilly requested a review from a team May 14, 2024 20:59
Copy link
Contributor

coderabbitai bot commented May 14, 2024

Warning

Rate Limit Exceeded

@cpengilly has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 27 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 0694d54 and fbb332b.

Walkthrough

The recent updates in the documentation focus on refining hyperlinks to specific sections like rollups, smart contracts, and design principles. Metadata adjustments and redirects enhance navigation and clarity for users seeking detailed information within the OP Stack documentation.

Changes

File Path Change Summary
pages/builders/app-developers/bridging/messaging.mdx
pages/chain/addresses.mdx
pages/connect/contribute/stack-contribute.mdx
pages/stack/getting-started.mdx
pages/stack/security/faq.mdx
Updated hyperlinks to more precise locations within the documentation.
pages/builders/chain-operators/self-hosted.mdx Updated links for L1 and L2 smart contracts within the OP Stack protocol.
pages/stack/_meta.json Updated the "explainer" value to "Design Philosophy & Principles".
pages/stack/protocol/_meta.json Renamed and removed sections, focusing on rollups and fault-proofs.
pages/stack/protocol/rollups/_meta.json Introduced metadata entries for various rollup-related sections.
public/_redirects Redirected URLs to specific locations within the documentation, emphasizing rollups and design principles.
words.txt Altered entity name from Rollups to Rollup.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.
  • 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: 2

Out of diff range and nitpick comments (12)
pages/builders/chain-operators/self-hosted.mdx (1)

Line range hint 96-96: Consider rephrasing "Adding a Precompile" for clarity.

The term "Precompile" might be non-standard in this context. Consider rephrasing to "Adding Precompiled Contracts" for better clarity.

- [Adding a Precompile](tutorials/adding-precompiles)
+ [Adding Precompiled Contracts](tutorials/adding-precompiles)
pages/builders/app-developers/bridging/messaging.mdx (8)

Line range hint 57-57: Consider using a shorter alternative to "exact same".

The phrase "exact same" might be wordy. Consider using "same" instead.

- they're doing the exact same thing.
+ they're doing the same thing.

Line range hint 89-89: Consider using a stronger adverb.

The phrase "completely different network" might be strengthened by using a different adverb.

- a completely different network.
+ an entirely different network.

Line range hint 131-131: Consider using an en dash for the range.

When specifying a range, consider using an en dash instead of a hyphen.

- take **approximately 1-3 minutes**
+ take **approximately 1–3 minutes**

Line range hint 153-153: Avoid repetitive sentence beginnings.

Three successive sentences begin with "This". Consider rewording for variety.

- This waiting period is a core part of the security model of the OP Stack and cannot be circumvented.
+ The waiting period is a core part of the security model of the OP Stack and cannot be circumvented.

Line range hint 160-160: Consider a shorter alternative to avoid wordiness.

The phrase "In order to get around this" might be wordy. Consider using "To address this".

- In order to get around this, you can find a `xDomainMessageSender` function
+ To address this, you can find a `xDomainMessageSender` function

Line range hint 161-161: Use the correct preposition.

The preposition “for” seems more appropriate than “to” in this context.

- function to each messenger:
+ function for each messenger:

Line range hint 205-205: Ensure the article "the" is included.

You might be missing the article “the” here.

- after L2 block, including your L2 transaction,
+ after the L2 block, including your L2 transaction,

Line range hint 231-231: Include a comma after "Otherwise".

A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.

- Otherwise you might be making decisions based on an invalid transaction result.
+ Otherwise, you might be making decisions based on an invalid transaction result.
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (3)

Line range hint 125-125: Use "an" before nouns that start with a vowel sound.

- You'll be deploying a OP Stack Rollup chain that uses a Layer 1 blockchain to host and order transaction data.
+ You'll be deploying an OP Stack Rollup chain that uses a Layer 1 blockchain to host and order transaction data.

Line range hint 319-319: Add a comma for clarity.

- You do not need to send any ETH to the `Sequencer` address as it does not send transactions.
+ You do not need to send any ETH to the `Sequencer` address, as it does not send transactions.

Line range hint 625-625: Add a comma for clarity.

- Once you've got `op-geth` running you'll need to run `op-node`.
+ Once you've got `op-geth` running, you'll need to run `op-node`.

@cpengilly
Copy link
Contributor Author

@sbvegan i think we can still merge since the link issues are with outside links (not internal)

Copy link
Collaborator

@sbvegan sbvegan left a comment

Choose a reason for hiding this comment

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

a bit of a nit, but the OP Stack is a singular rollup

@cpengilly cpengilly requested a review from sbvegan May 15, 2024 14:05
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: 2

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: 2

Out of diff range and nitpick comments (61)
words.txt (61)

Line range hint 1-2: Remove duplicate entries for ACCOUNTQUEUE and accountqueue.

- ACCOUNTQUEUE
- accountqueue
+ ACCOUNTQUEUE
+ accountqueue

Line range hint 19-22: Remove duplicate entries for BLOCKLOGS and blocklogs.

- BLOCKLOGS
- blocklogs
+ BLOCKLOGS
+ blocklogs

Line range hint 24-27: Remove duplicate entries for BLOCKPROFILERATE and blockprofilerate.

- BLOCKPROFILERATE
- blockprofilerate
+ BLOCKPROFILERATE
+ blockprofilerate

Line range hint 32-36: Remove duplicate entries for Bootnodes and bootnodes.

- Bootnodes
- bootnodes
+ Bootnodes
+ bootnodes

Line range hint 40-47: Remove duplicate entries for Chainlink and chainlist.

- Chainlink
- chainlist
+ Chainlink
+ chainlist

Line range hint 53-55: Remove duplicate entries for DATADIR and datadir.

- DATADIR
- datadir
+ DATADIR
+ datadir

Line range hint 59-63: Remove duplicate entries for Devnet and devnet.

- Devnet
- devnet
+ Devnet
+ devnet

Line range hint 65-68: Remove duplicate entries for DISABLETXPOOLGOSSIP and disabletxpoolgossip.

- DISABLETXPOOLGOSSIP
- disabletxpoolgossip
+ DISABLETXPOOLGOSSIP
+ disabletxpoolgossip

Line range hint 70-72: Remove duplicate entries for ETHERBASE and etherbase.

- ETHERBASE
- etherbase
+ ETHERBASE
+ etherbase

Line range hint 74-76: Remove duplicate entries for ETHSTATS and ethstats.

- ETHSTATS
- ethstats
+ ETHSTATS
+ ethstats

Line range hint 78-80: Remove duplicate entries for EVMTIMEOUT and evmtimeout.

- EVMTIMEOUT
- evmtimeout
+ EVMTIMEOUT
+ evmtimeout

Line range hint 84-92: Remove duplicate entries for GLOBALQUEUE and globalqueue.

- GLOBALQUEUE
- globalqueue
+ GLOBALQUEUE
+ globalqueue

Line range hint 95-98: Remove duplicate entries for GLOBALSLOTS and globalslots.

- GLOBALSLOTS
- globalslots
+ GLOBALSLOTS
+ globalslots

Line range hint 100-106: Remove duplicate entries for HEALTHCHECK and healthcheck.

- HEALTHCHECK
- healthcheck
+ HEALTHCHECK
+ healthcheck

Line range hint 109-111: Remove duplicate entries for HISTORICALRPC and historicalrpc.

- HISTORICALRPC
- historicalrpc
+ HISTORICALRPC
+ historicalrpc

Line range hint 113-116: Remove duplicate entries for HISTORICALRPCTIMEOUT and historicalrpctimeout.

- HISTORICALRPCTIMEOUT
- historicalrpctimeout
+ HISTORICALRPCTIMEOUT
+ historicalrpctimeout

Line range hint 119-121: Remove duplicate entries for INFLUXDBV and influxdbv.

- INFLUXDBV
- influxdbv
+ INFLUXDBV
+ influxdbv

Line range hint 124-127: Remove duplicate entries for IPCPATH and ipcpath.

- IPCPATH
- ipcpath
+ IPCPATH
+ ipcpath

Line range hint 140-142: Remove duplicate entries for MAXAGE and maxage.

- MAXAGE
- maxage
+ MAXAGE
+ maxage

Line range hint 144-146: Remove duplicate entries for MAXBACKUPS and maxbackups.

- MAXBACKUPS
- maxbackups
+ MAXBACKUPS
+ maxbackups

Line range hint 148-151: Remove duplicate entries for MAXPEERS and maxpeers.

- MAXPEERS
- maxpeers
+ MAXPEERS
+ maxpeers

Line range hint 153-157: Remove duplicate entries for MAXPENDPEERS and maxpendpeers.

- MAXPENDPEERS
- maxpendpeers
+ MAXPENDPEERS
+ maxpendpeers

Line range hint 159-175: Remove duplicate entries for MINFREEDISK and minfreedisk.

- MINFREEDISK
- minfreedisk
+ MINFREEDISK
+ minfreedisk

Line range hint 177-179: Remove duplicate entries for MINSUGGESTEDPRIORITYFEE and minsuggestedpriorityfee.

- MINSUGGESTEDPRIORITYFEE
- minsuggestedpriorityfee
+ MINSUGGESTEDPRIORITYFEE
+ minsuggestedpriorityfee

Line range hint 182-184: Remove duplicate entries for NETWORKID and networkid.

- NETWORKID
- networkid
+ NETWORKID
+ networkid

Line range hint 186-189: Remove duplicate entries for NEWPAYLOAD and newpayload.

- NEWPAYLOAD
- newpayload
+ NEWPAYLOAD
+ newpayload

Line range hint 191-193: Remove duplicate entries for NOCOMPACTION and nocompaction.

- NOCOMPACTION
- nocompaction
+ NOCOMPACTION
+ nocompaction

Line range hint 195-197: Remove duplicate entries for NODEKEY and nodekey.

- NODEKEY
- nodekey
+ NODEKEY
+ nodekey

Line range hint 200-207: Remove duplicate entries for NODEKEYHEX and nodekeyhex.

- NODEKEYHEX
- nodekeyhex
+ NODEKEYHEX
+ nodekeyhex

Line range hint 210-212: Remove duplicate entries for NODISCOVER and nodiscover.

- NODISCOVER
- nodiscover
+ NODISCOVER
+ nodiscover

Line range hint 220-224: Remove duplicate entries for NOLOCALS and nolocals.

- NOLOCALS
- nolocals
+ NOLOCALS
+ nolocals

Line range hint 228-230: Remove duplicate entries for NOPREFETCH and noprefetch.

- NOPREFETCH
- noprefetch
+ NOPREFETCH
+ noprefetch

Line range hint 233-235: Remove duplicate entries for NOPRUNING and nopruning.

- NOPRUNING
- nopruning
+ NOPRUNING
+ nopruning

Line range hint 242-246: Remove duplicate entries for NOSYNCSERVE and nosyncserve.

- NOSYNCSERVE
- nosyncserve
+ NOSYNCSERVE
+ nosyncserve

Line range hint 248-250: Remove duplicate entries for Offchain and offchain.

- Offchain
- offchain
+ Offchain
+ offchain

Line range hint 262-278: Remove duplicate entries for peerstores and Permissioned.

- peerstores
- Permissioned
+ peerstores
+ Permissioned

Line range hint 283-285: Remove duplicate entries for permissioned and Permissionless.

- permissioned
- Permissionless
+ permissioned
+ Permissionless

Line range hint 288-290: Remove duplicate entries for permissionless and permissionlessly.

- permissionless
- permissionlessly
+ permissionless
+ permissionlessly

Line range hint 300-305: Remove duplicate entries for preconfigured and predeploy.

- preconfigured
- predeploy
+ preconfigured
+ predeploy

Line range hint 308-310: Remove duplicate entries for Predeployed and predeployed.

- Predeployed
- predeployed
+ Predeployed
+ predeployed

Line range hint 312-314: Remove duplicate entries for predeploys and Preimage.

- predeploys
- Preimage
+ predeploys
+ Preimage

Line range hint 321-321: Remove duplicate entries for PREIMAGES and preimages.

- PREIMAGES
- preimages
+ PREIMAGES
+ preimages

Line range hint 1-321: Remove duplicate entries for Preinstalls and preinstalls.

- Preinstalls
- preinstalls
+ Preinstalls
+ preinstalls

Line range hint 1-321: Remove duplicate entries for prestate and PRICEBUMP.

- prestate
- PRICEBUMP
+ prestate
+ PRICEBUMP

Line range hint 1-321: Remove duplicate entries for pricebump and PRICELIMIT.

- pricebump
- PRICELIMIT
+ pricebump
+ PRICELIMIT

Line range hint 1-321: Remove duplicate entries for pricelimit and productionize.

- pricelimit
- productionize
+ pricelimit
+ productionize

Line range hint 1-321: Remove duplicate entries for productionized and Protip.

- productionized
- Protip
+ productionized
+ Protip

Line range hint 1-321: Remove duplicate entries for proxyd and pseudorandomly.

- proxyd
- pseudorandomly
+ proxyd
+ pseudorandomly

Line range hint 1-321: Remove duplicate entries for Quicknode and quicknode.

- Quicknode
- quicknode
+ Quicknode
+ quicknode

Line range hint 1-321: Remove duplicate entries for quickstarts and RANDAO.

- quickstarts
- RANDAO
+ quickstarts
+ RANDAO

Line range hint 1-321: Remove duplicate entries for Regenesis and regenesis.

- Regenesis
- regenesis
+ Regenesis
+ regenesis

Line range hint 1-321: Remove duplicate entries for REJOURNAL and rejournal.

- REJOURNAL
- rejournal
+ REJOURNAL
+ rejournal

Line range hint 1-321: Remove duplicate entries for REMOTEDB and remotedb.

- REMOTEDB
- remotedb
+ REMOTEDB
+ remotedb

Line range hint 1-321: Remove duplicate entries for replayability and REQUIREDBLOCKS.

- replayability
- REQUIREDBLOCKS
+ replayability
+ REQUIREDBLOCKS

Line range hint 1-321: Remove duplicate entries for requiredblocks and Rollups.

- requiredbocks
- Rollups
+ requiredbocks
+ Rollups

Line range hint 1-321: Remove duplicate entries for rpckind and RPCPREFIX.

- rpckind
- RPCPREFIX
+ rpckind
+ RPCPREFIX

Line range hint 1-321: Remove duplicate entries for rpcprefix and RPGF.

- rpcprefix
- RPGF
+ rpcprefix
+ RPGF

Line range hint 1-321: Remove duplicate entries for SELFDESTRUCT and seqnr.

- SELFDESTRUCT
- seqnr
+ SELFDESTRUCT
+ seqnr

Line range hint 1-321: Remove duplicate entries for SEQUENCERHTTP and sequencerhttp.

- SEQUENCERHTTP
- sequencerhttp
+ SEQUENCERHTTP
+ sequencerhttp

Line range hint 1-321: Remove duplicate entries for Shapella and signup.

- Shapella
- signup
+ Shapella
+ signup

Line range hint 1-321: Remove duplicate entries for SLLV and SLTI.

- SLLV
- SLTI
+ SLLV
+ SLTI

@sbvegan sbvegan merged commit 61833dc into main May 15, 2024
@sbvegan sbvegan deleted the protocol-updates branch May 15, 2024 14:17
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