cgt comms #1402
cgt comms #1402
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request deprecates the Custom Gas Token (CGT) feature in the documentation. It introduces a new JSON entry in Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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 (2)
pages/notices/custom-gas-tokens-deprecation.mdx (2)
9-10: Refine language to avoid personal pronouns.
In line 9, the phrase “allowing us to validate demand” uses a personal pronoun. Replace “us” with a proper reference (for example, “allowing Optimism Labs to validate demand”) to maintain an objective and consistent tone throughout the documentation.
24-25: Adopt an objective tone in recommendations.
The phrase “We strongly recommend:” in the recommendations section should be revised to remove personal pronouns. Consider rephrasing it as “Optimism recommends:” to enhance clarity and formality.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
pages/notices/_meta.json(1 hunks)pages/notices/custom-gas-tokens-deprecation.mdx(1 hunks)pages/operators/chain-operators/configuration/rollup.mdx(0 hunks)pages/operators/chain-operators/features.mdx(1 hunks)pages/operators/chain-operators/features/_meta.json(0 hunks)pages/operators/chain-operators/features/alt-da-mode.mdx(0 hunks)pages/operators/chain-operators/features/custom-gas-token.mdx(0 hunks)pages/stack/beta-features.mdx(0 hunks)pages/stack/beta-features/_meta.json(0 hunks)pages/stack/beta-features/custom-gas-token.mdx(0 hunks)pages/stack/fact-sheet.mdx(1 hunks)pages/stack/interop/tutorials/bridge-crosschain-eth.mdx(0 hunks)pages/superchain/blockspace-charter.mdx(0 hunks)pages/superchain/standard-configuration.mdx(1 hunks)
💤 Files with no reviewable changes (9)
- pages/stack/beta-features/_meta.json
- pages/operators/chain-operators/features/_meta.json
- pages/stack/interop/tutorials/bridge-crosschain-eth.mdx
- pages/superchain/blockspace-charter.mdx
- pages/stack/beta-features.mdx
- pages/operators/chain-operators/features/custom-gas-token.mdx
- pages/operators/chain-operators/features/alt-da-mode.mdx
- pages/stack/beta-features/custom-gas-token.mdx
- pages/operators/chain-operators/configuration/rollup.mdx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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/operators/chain-operators/features.mdxpages/notices/custom-gas-tokens-deprecation.mdxpages/superchain/standard-configuration.mdxpages/stack/fact-sheet.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (4)
pages/stack/fact-sheet.mdx (1)
32-33: Clarify reference to custom gas token deprecation.
The removal of the explanatory footnote regarding custom gas tokens is appropriate given the deprecation. Ensure that readers looking for further details on the Custom Gas Tokens deprecation are clearly directed to the new document inpages/notices/custom-gas-tokens-deprecation.mdx.pages/notices/_meta.json (1)
4-5: Update metadata for deprecation notices.
The addition of the"custom-gas-tokens-deprecation": "Preparing for Custom Gas Tokens deprecation"key-value pair aligns with the deprecation strategy and ensures that metadata remains current. Please verify that all dependent documentation references reflect this update.pages/operators/chain-operators/features.mdx (1)
15-23: Confirm removal of deprecated feature reference.
The removed card element for the custom gas token chain is consistent with deprecating that feature. Ensure that any internal links or mentions of the deprecated feature (for example, in complementary guides) are updated so that readers are not misdirected.pages/superchain/standard-configuration.mdx (1)
32-33: Broadening description of non-standard configurations.
Changing the language to reference unsupported features in general (instead of explicitly citing custom gas tokens) is a prudent move that aligns with the deprecation. Consider, however, including a cross-reference or note for readers who might need further clarification regarding the removal of custom gas token support.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
words.txt (1)
423-423: Verify New Entry 'upstreaming' and Address Static Analysis Duplication WarningThe new word "upstreaming" has been added at line 423. Please confirm that this is intentional and not a duplicate of an existing entry. The static analysis tool flagged a possible duplication at this line ("Možný preklep: zopakovali ste slovo"). If "upstreaming" is meant to be unique, you can safely ignore this warning; otherwise, consider removing or correcting the duplicate entry.
🧰 Tools
🪛 LanguageTool
[duplication] ~423-~423: Možný preklep: zopakovali ste slovo
Context: ... Unprotect unsubmitted UPNP upstreaming VERKLE verkle VHOSTS vhosts Viem viem Viem's viem's V...(WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
words.txt(1 hunks)
🧰 Additional context used
🪛 LanguageTool
words.txt
[duplication] ~423-~423: Možný preklep: zopakovali ste slovo
Context: ... Unprotect unsubmitted UPNP upstreaming VERKLE verkle VHOSTS vhosts Viem viem Viem's viem's V...
(WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
No description provided.