Custom Gas Token docs fix #718
Conversation
WalkthroughThe recent changes to the Changes
Recent Review DetailsConfiguration used: .coderabbit.yaml Files selected for processing (1)
Additional Context UsedLanguageTool (5)
Path-based Instructions (1)
Additional comments not posted (1)
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. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
pages/builders/chain-operators/management/custom-gas-token.mdx (3)
Line range hint
21-21: Revise the verb usage for clarity.The verb "Checkout" might be confusing here. Consider using "Check out" as two words to clarify that it's an action:
- Checkout the [`v2.0.0-beta.1` of the contracts](https://github.com/ethereum-optimism/optimism/tree/op-contracts/v2.0.0-beta.1) and use the commit to deploy. + Check out the [`v2.0.0-beta.1` of the contracts](https://github.com/ethereum-optimism/optimism/tree/op-contracts/v2.0.0-beta.1) and use the commit to deploy.
Line range hint
27-27: Standardize terminology for consistency.The term "deploy" is used inconsistently. Consider using "deployment" for clarity and consistency:
- Update the deploy config in `contracts-bedrock/deploy-config` with new fields: `useCustomGasToken` and `customGasTokenAddress` + Update the deployment configuration in `contracts-bedrock/deploy-config` with new fields: `useCustomGasToken` and `customGasTokenAddress` - `DEPLOY_CONFIG_PATH` is the path to the file for the deploy config used to deploy + `DEPLOY_CONFIG_PATH` is the path to the file for the deployment configuration used to deploy - `DEPLOY_CONFIG_PATH` is the path to the file for the deploy config used to deploy + `DEPLOY_CONFIG_PATH` is the path to the file for the deployment configuration used to deployAlso applies to: 63-63, 85-85
Line range hint
108-108: Correct grammatical errors for clarity.There are a couple of grammatical issues in this line that could lead to confusion:
- This calls the `WETH` predeploy which should be considered wrapped native asset in the context of custom gas token. + This calls the `WETH` predeploy, which should be considered a wrapped native asset in the context of custom gas tokens.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (3)
pages/builders/chain-operators/management/custom-gas-token.mdx (3)
Line range hint
21-21: Consider starting the sentence with a verb or adding a comma for clarity.- Checkout the [`v2.0.0-beta.1` of the contracts](https://github.com/ethereum-optimism/optimism/tree/op-contracts/v2.0.0-beta.1) and use the commit to deploy. + Check out the [`v2.0.0-beta.1` of the contracts](https://github.com/ethereum-optimism/optimism/tree/op-contracts/v2.0.0-beta.1), and use the commit to deploy.
Line range hint
27-27: Use "deployment" instead of "deploy" for clarity.- Update the deploy config in `contracts-bedrock/deploy-config` with new fields: `useCustomGasToken` and `customGasTokenAddress` + Update the deployment config in `contracts-bedrock/deploy-config` with new fields: `useCustomGasToken` and `customGasTokenAddress` - `DEPLOY_CONFIG_PATH` is the path to the file for the deploy config used to deploy + `DEPLOY_CONFIG_PATH` is the path to the file for the deployment config used to deploy - `DEPLOY_CONFIG_PATH` is the path to the file for the deploy config used to deploy + `DEPLOY_CONFIG_PATH` is the path to the file for the deployment config used to deployAlso applies to: 63-63, 85-85
Line range hint
108-108: Add a comma for better readability.- This calls the `WETH` predeploy which should be considered wrapped native asset in the context of custom gas token. + This calls the `WETH` predeploy, which should be considered wrapped native asset in the context of custom gas token.
Description
Add section calling out withdrawal network must be 1 for CGT