fix(cleanup): replace dangling plasma refs with altda #1258
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a comprehensive documentation update across multiple files, focusing on renaming terminology from "Plasma" to "Alt-DA" (Alternative Data Availability). This change affects configuration documentation, glossary entries, and explanatory pages related to the OP Stack. The modifications include updating command-line arguments, environment variables, configuration options, and descriptive text to reflect the new terminology. The changes are consistent across different documentation pages, ensuring a unified approach to describing the data availability mechanism and its configuration. Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Configuration
participant AltDASystem
User->>Docs: Reads documentation
Docs->>Configuration: Provides updated config instructions
User->>Configuration: Applies new configuration
Configuration->>AltDASystem: Configures with Alt-DA parameters
AltDASystem-->>Configuration: Confirms configuration
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolwords.txt[duplication] ~284-~284: Möglicher Tippfehler: ein Wort wird wiederholt (GERMAN_WORD_REPEAT_RULE) ⏰ Context from checks skipped due to timeout of 90000ms (4)
🔇 Additional comments (2)
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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/superchain/superchain-explainer.mdx (1)
267-267: Fix grammar in the Alt-DA protocol introduction.Use "an" instead of "a" before "Alt-DA protocol" as words starting with vowel sounds require "an".
-Today L1 data availability (DA) does not scale nearly enough to be able to support internet-level scale. However, it is possible to extend the amount of data availability accessible to OP Chains by using a Alt-DA protocol which enables alternative DA providers to supplement the more limited L1 DA. +Today L1 data availability (DA) does not scale nearly enough to be able to support internet-level scale. However, it is possible to extend the amount of data availability accessible to OP Chains by using an Alt-DA protocol which enables alternative DA providers to supplement the more limited L1 DA.Also applies to: 275-275
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
pages/builders/chain-operators/configuration/batcher.mdx(1 hunks)pages/builders/chain-operators/configuration/rollup.mdx(4 hunks)pages/connect/resources/glossary.mdx(1 hunks)pages/stack/beta-features/alt-da-mode.mdx(1 hunks)pages/stack/beta-features/custom-gas-token.mdx(1 hunks)pages/superchain/superchain-explainer.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/stack/beta-features/custom-gas-token.mdx
🧰 Additional context used
📓 Path-based instructions (5)
pages/stack/beta-features/alt-da-mode.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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/connect/resources/glossary.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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/builders/chain-operators/configuration/batcher.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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/builders/chain-operators/configuration/rollup.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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/superchain/superchain-explainer.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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/builders/chain-operators/configuration/batcher.mdx
[style] ~271-~271: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... <Tabs.Tab>--altda.da-server=</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_DA_SERVE...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~282-~282: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...bs.Tab>--altda.da-service=false</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_DA_SERVI...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~292-~292: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...<Tabs.Tab>--altda.enabled=false</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_ENABLED=...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~303-~303: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Tab>--altda.verify-on-read=true</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_VERIFY_O...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
pages/superchain/superchain-explainer.mdx
[misspelling] ~275-~275: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...bility accessible to OP Chains by using a Alt-DA protocol which enables alternati...
(EN_A_VS_AN)
[style] ~283-~283: As a shorter alternative for ‘able to’, consider using “can”.
Context: .... A generic Alt-DA protocol is able to scale beyond what is possible on L1 bec...
(BE_ABLE_TO)
[style] ~283-~283: Consider removing “of” to be more concise
Context: ...eas on L1 every Ethereum node downloads all of the transaction data on L1. This means that...
(ALL_OF_THE)
[style] ~292-~292: Consider a shorter alternative to avoid wordiness.
Context: ...ction to withdraw from the Alt-DA chain in order to switch their DA Provider. * Settlemen...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (9)
pages/stack/beta-features/alt-da-mode.mdx (1)
34-34: LGTM! Terminology update is accurate.The change from "Plasma Data Availability Challenges" to "Alt-DA Challenges" aligns with the broader initiative to update terminology across the documentation.
pages/builders/chain-operators/configuration/batcher.mdx (4)
265-272: LGTM! Configuration option renamed correctly.The
altda.da-serverconfiguration and its related environment variables are properly renamed from the previous "plasma" prefix.🧰 Tools
🪛 LanguageTool
[style] ~271-~271: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... <Tabs.Tab>--altda.da-server=</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_DA_SERVE...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
275-283: LGTM! Service configuration updated consistently.The
altda.da-serviceconfiguration maintains its functionality while adopting the new terminology.🧰 Tools
🪛 LanguageTool
[style] ~282-~282: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...bs.Tab>--altda.da-service=false</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_DA_SERVI...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
286-293: LGTM! Enable flag renamed appropriately.The
altda.enabledconfiguration preserves its boolean nature and default value while updating to the new naming scheme.🧰 Tools
🪛 LanguageTool
[style] ~292-~292: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...<Tabs.Tab>--altda.enabled=false</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_ENABLED=...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
296-304: LGTM! Verification option updated correctly.The
altda.verify-on-readconfiguration maintains its verification functionality while adopting the new terminology.🧰 Tools
🪛 LanguageTool
[style] ~303-~303: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Tab>--altda.verify-on-read=true</Tabs.Tab> <Tabs.Tab>`OP_BATCHER_ALTDA_VERIFY_O...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
pages/connect/resources/glossary.mdx (1)
252-252: LGTM! Glossary term updated accurately.The "Alt-DA Chain" definition maintains technical accuracy while aligning with the new terminology.
pages/builders/chain-operators/configuration/rollup.mdx (2)
Line range hint
1010-1016: LGTM! Configuration flag renamed appropriately.The
useAltDAflag replacesusePlasmawhile maintaining its functionality as a boolean indicator.
1043-1043: LGTM! Configuration notes updated consistently.The notes for
daChallengeWindow,daResolveWindow, anddaChallengeProxyhave been updated to reference "altda mode" while maintaining their technical requirements.Also applies to: 1056-1056, 1095-1095
pages/superchain/superchain-explainer.mdx (1)
278-280: LGTM! Protocol description updated accurately.The Alt-DA protocol description maintains technical accuracy while adopting the new terminology. The explanation of data availability challenges and security model remains clear and precise.
Also applies to: 283-295
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
words.txt (1)
293-293: Consider standardizing case conventions.While the addition of "PREVRANDAO" is valid, the casing seems inconsistent with other similar technical terms in the list. Consider establishing clear guidelines for term casing.
🧰 Tools
🪛 LanguageTool
[duplication] ~293-~293: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ... Prestate prestate prestates PREVRANDAO PRICEBUMP pricebump PRICELIMIT pricelimit productionize pro...(GERMAN_WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pages/stack/differences.mdx(1 hunks)pages/stack/interop/op-supervisor.mdx(1 hunks)pages/stack/interop/security.mdx(1 hunks)words.txt(2 hunks)
✅ Files skipped from review due to trivial changes (3)
- pages/stack/differences.mdx
- pages/stack/interop/op-supervisor.mdx
- pages/stack/interop/security.mdx
🧰 Additional context used
🪛 LanguageTool
words.txt
[duplication] ~293-~293: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ... Prestate prestate prestates PREVRANDAO PRICEBUMP pricebump PRICELIMIT pricelimit productionize pro...
(GERMAN_WORD_REPEAT_RULE)
⏰ 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 (1)
words.txt (1)
12-12: LGTM: Term addition aligns with PR objectives.The addition of "altda" is consistent with the PR's goal of replacing plasma references.
The plasma feature was renamed to altda several months ago. This pr cleans up some of the old references to plasma scattered throughout the docs and replaces them with the new altda name