Skip to content

Conversation

@bradleycamacho
Copy link
Contributor

@bradleycamacho bradleycamacho commented Jan 13, 2025

Still needs various fixes and nav work.

Closes https://github.com/ethereum-optimism/devrel/issues/371

Ensure we add redirects

Still needs various nav fixes an a second eye on necessary changes
@bradleycamacho bradleycamacho requested a review from a team as a code owner January 13, 2025 17:18
@netlify
Copy link

netlify bot commented Jan 13, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 855ef6e
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/679d77d4ed68a200087918da
😎 Deploy Preview https://deploy-preview-1243--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.

@bradleycamacho bradleycamacho marked this pull request as draft January 13, 2025 17:19
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Warning

Rate limit exceeded

@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 41 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

Reviewing files that changed from the base of the PR and between 23fc2ba and 855ef6e.

📒 Files selected for processing (1)
  • words.txt (1 hunks)
📝 Walkthrough

Walkthrough

This pull request represents a comprehensive documentation restructuring for the Optimism ecosystem, focusing on transitioning from "OP Mainnet" to "OP Stack" terminology and reorganizing documentation paths. The changes span multiple files and directories, primarily involving updates to URL references, terminology, and navigation structures. Key modifications include removing the "Hacks" section, updating links across various documentation pages, and refactoring the documentation to provide a more unified and consistent approach to describing OP Stack chains and development processes.

Sequence Diagram

sequenceDiagram
    participant User
    participant Docs
    participant NewStructure
    participant OldStructure

    User->>Docs: Access documentation
    Docs->>OldStructure: Previous routing
    OldStructure-->>Docs: Redirect
    Docs->>NewStructure: Updated routing
    NewStructure-->>User: Provide documentation
Loading

Possibly related issues

  • ethereum-optimism/docs#993: Relates to updating the genesis.mdx file, which aligns with the documentation restructuring in this PR.
  • ethereum-optimism/docs#917: Directly connected to updating the L2 rollup tutorial, which is part of the documentation changes in this PR.
  • ethereum-optimism/docs#627: Focuses on improving the L2 Testnet tutorial, which is consistent with the documentation updates in this PR.

Suggested labels

documentation, flag:merge-pending-release

Suggested reviewers

  • sbvegan
  • zainbacchus

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Nitpick comments (10)
pages/chain/addresses.mdx (1)

14-14: Consider rephrasing for clarity and conciseness.

The sentence repeats information about the superchain-registry that's already mentioned in the following callout. Consider:

-This reference guide lists all the contract addresses for OP Stack chains, as found on the [superchain-registry](https://github.com/ethereum-optimism/superchain-registry/tree/main). 
+This reference guide lists all the contract addresses for OP Stack chains.
pages/chain/testing/testing-apps.mdx (2)

15-15: Improve text formatting and clarity.

The italicized word placement within "could" makes the sentence awkward. Consider:

-In those cases, while you *could* test everything on an OP Stack chain or a test network, that would normally be inefficient.
+In those cases, while you could test everything on an OP Stack chain or a test network, this would normally be inefficient.

21-21: Break down the complex sentence for better readability.

The sentence is too long and could be split for clarity:

-Running proper testing is key to identifying fringe cases where the equivalence between OP Stack chains and Ethereum breaks down (or where Ethereum mainnet itself and the development stack may be non-equivalent in a production environment).
+Running proper testing is key to identifying fringe cases where the equivalence between OP Stack chains and Ethereum breaks down. This testing can also reveal cases where Ethereum mainnet itself and the development stack may be non-equivalent in a production environment.
pages/chain/security/security-policy.mdx (1)

31-31: Improve sentence structure and conciseness.

The sentence contains redundant phrasing and missing punctuation:

-If you think you have found a significant bug or vulnerabilities in OP Stack smart contracts, infrastructure, etc., even if that component is not covered by an existing bug bounty, please report it via the [Immunefi program](https://immunefi.com/bounty/optimism/). The impact of any and all reported issues will be considered and the program has previously rewarded security researchers for bugs not within its stated scope.
+If you think you have found a significant bug or vulnerabilities in OP Stack smart contracts, infrastructure, etc., even if that component is not covered by an existing bug bounty, please report it via the [Immunefi program](https://immunefi.com/bounty/optimism/). The impact of all reported issues will be considered, and the program has previously rewarded security researchers for bugs not within its stated scope.
🧰 Tools
🪛 LanguageTool

[style] ~31-~31: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fi.com/bounty/optimism/). The impact of any and all reported issues will be considered and ...

(EN_WORDINESS_PREMIUM_ANY_AND_ALL)


[uncategorized] ~31-~31: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...d all reported issues will be considered and the program has previously rewarded sec...

(COMMA_COMPOUND_SENTENCE_2)

pages/chain/getting-started.mdx (1)

55-55: Add missing comma before "such as".

-This lets you debug parts that are OP Stack chains specific such as calls to bridges to transfer ETH or tokens between layers.
+This lets you debug parts that are OP Stack chains specific, such as calls to bridges to transfer ETH or tokens between layers.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~55-~55: A comma might be missing here.
Context: ...ou debug parts that are OP Stack chains specific such as calls to bridges to transfer ET...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

pages/chain/security/faq.mdx (2)

18-19: Consider using a callout for critical security information.

This critical security information about the multisig dependency and potential risks should be more prominent. Consider using the Callout component:

-At the moment, **it's important to understand that the security of OP Stack chains is dependent on a [multisig](https://etherscan.io/address/0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A)** managed jointly by the [Optimism Security Council](https://gov.optimism.io/t/intro-to-optimisms-security-council/6885) and the Optimism Foundation.
-OP Stack chains **may also contain unknown bugs that could lead to the loss of some or all of the ETH or tokens held within the system**.
+<Callout type="warning">
+  The security of OP Stack chains is dependent on a [multisig](https://etherscan.io/address/0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A) managed jointly by the [Optimism Security Council](https://gov.optimism.io/t/intro-to-optimisms-security-council/6885) and the Optimism Foundation.
+
+  OP Stack chains may contain unknown bugs that could lead to the loss of some or all of the ETH or tokens held within the system.
+</Callout>

72-72: Add context for archived link.

The web.archive.org link should include a note about when it was archived for better context and transparency.

pages/chain/security/privileged-roles.mdx (3)

11-12: Improve conciseness in the introduction

Consider rephrasing for better clarity and conciseness:

-In their current state, OP Stack chains still include some "privileged" roles that give certain addresses the ability to carry out specific actions.
+OP Stack chains currently include privileged roles that grant specific capabilities to designated addresses.

41-41: Remove redundant phrase

The phrase "on OP Stack chains" is redundant in this context.

-No one has the private key for `0x6B1BAE59D09fCcbdDB6C6cceb07B7279367C4E3b` on OP Stack chains, which means the only way for the L2 ProxyAdmin owner to send transactions is via deposit transactions from the L1 `0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A` address.
+No one has the private key for `0x6B1BAE59D09fCcbdDB6C6cceb07B7279367C4E3b`, which means the only way for the L2 ProxyAdmin owner to send transactions is via deposit transactions from the L1 `0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A` address.

191-191: Improve sentence structure

The current sentence structure is complex and could be simplified.

-The Mint Manager Owner is an address that controls the [`MintManager`](https://github.com/ethereum-optimism/optimism/blob/62c7f3b05a70027b30054d4c8974f44000606fb7/packages/contracts-bedrock/contracts/governance/MintManager.sol) contract that can be used to mint new OP tokens on OP Stack chains.
+The Mint Manager Owner controls the [`MintManager`](https://github.com/ethereum-optimism/optimism/blob/62c7f3b05a70027b30054d4c8974f44000606fb7/packages/contracts-bedrock/contracts/governance/MintManager.sol) contract, which can mint new OP tokens on OP Stack chains.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c03602 and e01ae14.

📒 Files selected for processing (8)
  • pages/chain/addresses.mdx (1 hunks)
  • pages/chain/getting-started.mdx (4 hunks)
  • pages/chain/networks.mdx (1 hunks)
  • pages/chain/security/faq.mdx (2 hunks)
  • pages/chain/security/privileged-roles.mdx (6 hunks)
  • pages/chain/security/security-policy.mdx (2 hunks)
  • pages/chain/testing/testing-apps.mdx (2 hunks)
  • pages/chain/tokenlist.mdx (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • pages/chain/tokenlist.mdx
  • pages/chain/networks.mdx
🧰 Additional context used
📓 Path-based instructions (6)
pages/chain/addresses.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
pages/chain/security/security-policy.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
pages/chain/testing/testing-apps.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
pages/chain/security/faq.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
pages/chain/getting-started.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
pages/chain/security/privileged-roles.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
🪛 LanguageTool
pages/chain/security/security-policy.mdx

[style] ~31-~31: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fi.com/bounty/optimism/). The impact of any and all reported issues will be considered and ...

(EN_WORDINESS_PREMIUM_ANY_AND_ALL)


[uncategorized] ~31-~31: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...d all reported issues will be considered and the program has previously rewarded sec...

(COMMA_COMPOUND_SENTENCE_2)

pages/chain/security/faq.mdx

[grammar] ~10-~10: Possible agreement error. The noun OP seems to be uncountable; consider using: “much OP”, “a good deal of OP”.
Context: ...components' # OP Stack security model Many OP Stack chains, such as OP Mainnet, are a...

(MANY_NN_U)


[style] ~17-~17: For conciseness, consider replacing this expression with an adverb.
Context: ...trong as its lowest common denominator. At the moment, **it's important to understand that th...

(AT_THE_MOMENT)


[style] ~36-~36: This phrase is redundant. Consider using “inside”.
Context: ...ws the withdrawal was actually included inside of the OP Stack chain. Withdrawals are pro...

(OUTSIDE_OF)

pages/chain/getting-started.mdx

[uncategorized] ~55-~55: A comma might be missing here.
Context: ...ou debug parts that are OP Stack chains specific such as calls to bridges to transfer ET...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism
  • GitHub Check: pr-workflow
🔇 Additional comments (4)
pages/chain/getting-started.mdx (1)

12-12: Consider archiving external links.

The Medium article link is already using web.archive.org, which is good practice. However, consider adding a note about the archive date for context.

pages/chain/security/privileged-roles.mdx (3)

17-17: LGTM!

The description is clear and maintains proper terminology.


89-90: LGTM!

The description accurately explains the Batcher's role and maintains consistent terminology.


165-171: LGTM!

The Guardian's description and capabilities are clearly explained with consistent terminology.

@krofax krofax marked this pull request as ready for review February 1, 2025 01:16
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.

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 2

🔭 Outside diff range comments (5)
pages/builders/app-developers.mdx (1)

Line range hint 12-12: Update introductory text to reference OP Stack instead of OP Mainnet.

The introductory text still references OP Mainnet while the new cards and PR objectives focus on OP Stack.

-If you're a developer looking to build on OP Mainnet, you've come to the right place.
+If you're a developer looking to build on OP Stack chains, you've come to the right place.
pages/index.mdx (1)

Line range hint 7-11: Terminology consistency in builder guides:
In the “Guides for builders” section, several references still mention “OP Mainnet” (e.g., for app developers and node operators). Update these references to “OP Stack chains” to maintain consistency with the refactor across the documentation.

pages/stack/security/security-policy.mdx (2)

Line range hint 7-10: Ensure consistency in codebase references.
Although the metadata now emphasizes the OP Stack codebase, the introductory text still refers to both “OP Stack and OP Mainnet code” (e.g., “…for reporting bugs and provides specific reporting guidelines for OP Stack and OP Mainnet code contained within…”). To maintain clarity and consistency with the new focus, please update these references to mention only “OP Stack codebase” (or clarify the intended scope).


Line range hint 11-15: Update bug bounty program reference for consistency.
The section titled “Optimism bug bounty program” still mentions vulnerabilities found in the “OP Mainnet codebase.” It is recommended to change this to “OP Stack codebase” to reflect the updated terminology and focus.

pages/builders/app-developers/overview.mdx (1)

Line range hint 4-9: Terminology consistency required.
The front matter and body of the document continue to reference “OP Mainnet” (e.g., in the description and introductory paragraphs), whereas the overall rebranding effort is to shift toward “OP Stack chains.” For consistency with the new documentation structure, please update these instances—both in prose and within the card titles—to reflect “OP Stack chains.”

🧰 Tools
🪛 LanguageTool

[misspelling] ~16-~16: Did you mean “your”?
Context: ...t applications. ## Getting started If you're brand new to OP Mainnet, try starting w...

(YOUR_NN)

🧹 Nitpick comments (8)
pages/builders/app-developers/testing-apps.mdx (1)

34-35: Stylistic refinement suggestion:
The phrase “in many cases” appears repeatedly. Consider varying the wording slightly to enhance readability and set the narrative apart.

🧰 Tools
🪛 LanguageTool

[style] ~35-~35: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...hose contracts are also deployed there (in many cases they are).

(IN_MANY_STYLE_CASES)

pages/stack/security/security-policy.mdx (1)

31-31: Refine language for conciseness and clarity.
Consider replacing the phrase “any and all reported issues” with “all reported issues” and insert a comma before “and” to separate the independent clauses. This will improve readability and reduce wordiness.

🧰 Tools
🪛 LanguageTool

[style] ~31-~31: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fi.com/bounty/optimism/). The impact of any and all reported issues will be considered and ...

(EN_WORDINESS_PREMIUM_ANY_AND_ALL)


[uncategorized] ~31-~31: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...d all reported issues will be considered and the program has previously rewarded sec...

(COMMA_COMPOUND_SENTENCE_2)

pages/builders/app-developers/getting-started.mdx (1)

55-55: Insert missing comma for clarity.
In the sentence “This lets you debug parts that are OP Stack chains specific such as calls to bridges to transfer ETH or tokens between layers,” consider adding a comma after “specific” to improve readability. For example:

…debug parts that are OP Stack chains specific, such as calls to bridges to transfer ETH or tokens…

🧰 Tools
🪛 LanguageTool

[uncategorized] ~55-~55: Possible missing comma found.
Context: ...ou debug parts that are OP Stack chains specific such as calls to bridges to transfer ET...

(AI_HYDRA_LEO_MISSING_COMMA)

pages/stack/security/faq-sec-model.mdx (3)

9-13: Header and introductory content consistency.
The H1 header "OP Stack security model" adheres to the documentation style guidelines. One minor note: in line 11, the example "OP Mainnet" is used. If the intent is to uniformly promote the OP Stack terminology, consider clarifying the relationship of OP Mainnet to OP Stack chains for consistency.

🧰 Tools
🪛 LanguageTool

[grammar] ~10-~10: Possible agreement error. The noun OP seems to be uncountable; consider using: “much OP”, “a good deal of OP”.
Context: ...components' # OP Stack security model Many OP Stack chains, such as OP Mainnet, are a...

(MANY_NN_U)


18-18: Conciseness improvement suggestion.
The phrase "At the moment" in line 18 could be removed or rephrased to improve conciseness without affecting clarity.


36-36: Wording refinement.
Replace “included inside of” with “included within” (or simply “included in”) to improve clarity and conciseness.

🧰 Tools
🪛 LanguageTool

[style] ~36-~36: This phrase is redundant. Consider using “inside”.
Context: ...ws the withdrawal was actually included inside of the OP Stack chain. Withdrawals are pro...

(OUTSIDE_OF)

pages/connect/contribute/style-guide.mdx (1)

329-329: Revise FAQ link text for consistency with documentation refactor.
The added FAQ row now displays [FAQ: OP Mainnet Security Model](/stack/security/faq-sec-model). Since the URL has been updated to use /stack/security/faq-sec-model as part of the larger refactor, consider updating the display text to “FAQ: OP Stack Security Model” to maintain consistency with the new nomenclature.

pages/stack/interop/superchain-weth.mdx (1)

109-109: Consider revising the relative link for interop cluster chains.
The link for “Superchain interop cluster chains” currently uses a relative path (pages/stack/interop/explainer#superchain-interop-cluster). For consistency with other absolute links in the documentation, consider updating this to an absolute path (e.g., /stack/interop/explainer#superchain-interop-cluster).

🛑 Comments failed to post (2)
pages/builders/tools/overview.mdx (1)

13-13: 🛠️ Refactor suggestion

Terminology update recommendation:
In the sentence on line 13, the link text “[building on OP Mainnet]” should be updated to “[building on OP Stack chains]” to reflect the new terminology consistently across the documentation.

pages/stack/getting-started.mdx (1)

49-49: ⚠️ Potential issue

Correct the hyperlink syntax.
The markdown link for “the OP Stack Hacks developers repo” is malformed. Please change:

-[the OP Stack Hacks developers repo(/https://github.com/ethereum-optimism/developers/tree/main/docs)
+[the OP Stack Hacks developers repo](https://github.com/ethereum-optimism/developers/tree/main/docs)

This will ensure the link renders correctly.

📝 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.

-If you're interested in experimenting with the OP Stack, check out [the OP Stack Hacks developers repo(/https://github.com/ethereum-optimism/developers/tree/main/docs).
+If you're interested in experimenting with the OP Stack, check out [the OP Stack Hacks developers repo](https://github.com/ethereum-optimism/developers/tree/main/docs).

@cpengilly cpengilly merged commit f525e1a into main Feb 1, 2025
6 of 8 checks passed
@cpengilly cpengilly deleted the mainnet-refactor branch February 1, 2025 02:35
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.

3 participants