Add info on Tenderly #1363
Add info on Tenderly #1363
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request updates several documentation pages for OP Stack applications by adding and modifying content related to Tenderly. A new section titled "Testing and Staging with Tenderly" outlines the benefits of using Tenderly Virtual TestNets, including features such as Mainnet State Replication, unlimited test tokens, collaborative testing, CI/CD integration, and development tools for transaction analysis. Additionally, the changes update the descriptions and formatting across multiple files: the JSON structure of the Possibly related PRs
Suggested labels
Suggested reviewers
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 (5)
pages/app-developers/tools/build/analytics-tools.mdx (1)
22-27: Improve clarity and readability of the Tenderly section.The content structure is good, but there are opportunities to enhance readability:
- Add an introductory sentence before the bullet points to better set context.
- Consider grouping related features (monitoring, automation, simulation) together.
[Tenderly](https://tenderly.co/?mtm_campaign=ext-docs&mtm_kwd=optimism) provides comprehensive monitoring and security solutions for OP-powered Chains, allowing you to stay informed and respond proactively to potential issues in real time. +Tenderly offers the following key features: + * Configure [Tenderly Alerts](https://docs.tenderly.co/alerts/intro-to-alerts?mtm_campaign=ext-docs&mtm_kwd=optimism) for monitoring wallets and setting up real-time notifications on transactions and contract events. Notifications trigger external webhooks, PagerDuty, or chat apps like Telegram and Slack. * Rely on [Developer Explorer](https://docs.tenderly.co/developer-explorer?mtm_campaign=ext-docs&mtm_kwd=optimism) to monitor and analyze transaction execution with high level of details. * Use [Web3 Actions](https://docs.tenderly.co/web3-actions/intro-to-web3-actions?mtm_campaign=ext-docs&mtm_kwd=optimism) to automate predefined responses, improving security and user experience. * Integrate [Simulation RPC](https://docs.tenderly.co/simulations/single-simulations#simulate-via-rpc?mtm_campaign=ext-docs&mtm_kwd=optimism) to predict transaction outcomes such as the expected asset changes, precise gas usage, and emitted events.pages/app-developers/transactions/parameters.mdx (1)
63-66: Improve the introduction of the Tenderly gasPrice method.The sentence contains redundant use of "alternatively." Consider restructuring for better flow.
-Alternatively, you can rely on Tenderly's [`tenderly_gasPrice`](https://docs.tenderly.co/node/rpc-reference/optimism-mainnet/tenderly_gasPrice?mtm_campaign=ext-docs&mtm_kwd=optimism) to get real-time gas predictions with 3 levels of likelihood for transaction inclusion. +You can also use Tenderly's [`tenderly_gasPrice`](https://docs.tenderly.co/node/rpc-reference/optimism-mainnet/tenderly_gasPrice?mtm_campaign=ext-docs&mtm_kwd=optimism) to get real-time gas predictions with 3 levels of likelihood for transaction inclusion.🧰 Tools
🪛 LanguageTool
[style] ~66-~66: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...ternatively, you can rely on Tenderly's [tenderly_gasPrice](https://docs.tenderly.co/nod...(ADVERB_REPETITION_PREMIUM)
pages/app-developers/testing-apps.mdx (1)
44-44: Fix compound adjective hyphenation.The term "third party" should be hyphenated when used as a compound adjective before a noun.
-* Create a Virtual TestNet to get access to third party contracts (e.g. Uniswap) and it's latest or historical state. +* Create a Virtual TestNet to get access to third-party contracts (e.g., Uniswap) and its latest or historical state.Note: Also fixed "it's" to "its" and added a comma after "e.g."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eate a Virtual TestNet to get access to third party contracts (e.g. Uniswap) and it's lates...(EN_COMPOUND_ADJECTIVE_INTERNAL)
pages/app-developers/transactions/estimates.mdx (1)
40-40: Improve sentence structure while maintaining valuable content.The addition of Tenderly's gas estimation method is beneficial. However, let's improve readability by removing the redundant "alternatively".
-This means you can feed your transaction to the [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) JSON-RPC method just like you would on Ethereum. Alternatively, use Tenderly's [`tenderly_estimateGas`](https://docs.tenderly.co/node/rpc-reference/optimism-mainnet/tenderly_estimateGas) for 100% accurate gas estimations. +This means you can feed your transaction to the [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas) JSON-RPC method just like you would on Ethereum. You can also use Tenderly's [`tenderly_estimateGas`](https://docs.tenderly.co/node/rpc-reference/optimism-mainnet/tenderly_estimateGas) for 100% accurate gas estimations.🧰 Tools
🪛 LanguageTool
[style] ~40-~40: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...Ethereum. Alternatively, use Tenderly's [tenderly_estimateGas](https://docs.tenderly.co/...(ADVERB_REPETITION_PREMIUM)
pages/app-developers/tools/connect/rpc-providers.mdx (1)
141-141: Enhance URL tracking parameters.The content is well-structured and informative. Consider standardizing the URL tracking parameters to match other providers' format.
-[Tenderly](https://www.tenderly.co?mtm_campaign=ext-docs&mtm_kwd=optimism) +[Tenderly](https://www.tenderly.co?utm_source=op-docs&utm_medium=partner-docs)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
pages/app-developers/testing-apps.mdx(1 hunks)pages/app-developers/tools/_meta.json(1 hunks)pages/app-developers/tools/build/analytics-tools.mdx(1 hunks)pages/app-developers/tools/build/block-explorers.mdx(3 hunks)pages/app-developers/tools/build/faucets.mdx(1 hunks)pages/app-developers/tools/connect/rpc-providers.mdx(1 hunks)pages/app-developers/transactions/estimates.mdx(1 hunks)pages/app-developers/transactions/parameters.mdx(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/app-developers/tools/_meta.json
🧰 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/app-developers/tools/build/block-explorers.mdxpages/app-developers/tools/build/analytics-tools.mdxpages/app-developers/testing-apps.mdxpages/app-developers/tools/build/faucets.mdxpages/app-developers/tools/connect/rpc-providers.mdxpages/app-developers/transactions/estimates.mdxpages/app-developers/transactions/parameters.mdx
🪛 LanguageTool
pages/app-developers/testing-apps.mdx
[formatting] ~39-~39: Insert a comma after ‘cases’: “In many cases,”?
Context: ...s. ## Integration with other products In many cases a decentralized application requires th...
(IN_MOST_CASES_COMMA)
[uncategorized] ~44-~44: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eate a Virtual TestNet to get access to third party contracts (e.g. Uniswap) and it's lates...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
pages/app-developers/transactions/estimates.mdx
[style] ~40-~40: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...Ethereum. Alternatively, use Tenderly's [tenderly_estimateGas](https://docs.tenderly.co/...
(ADVERB_REPETITION_PREMIUM)
pages/app-developers/transactions/parameters.mdx
[style] ~66-~66: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...ternatively, you can rely on Tenderly's [tenderly_gasPrice](https://docs.tenderly.co/nod...
(ADVERB_REPETITION_PREMIUM)
🔇 Additional comments (2)
pages/app-developers/tools/build/faucets.mdx (1)
32-44: LGTM! Table formatting and content updates are well-structured.The table formatting is consistent, and the new Tenderly faucet entry is properly documented with appropriate links and network information.
pages/app-developers/tools/build/block-explorers.mdx (1)
70-82: LGTM! The Tenderly section is well-organized and comprehensive.The section provides a clear overview of Tenderly's Developer Explorer features with proper documentation links and tracking parameters.
|
@0xmariniere couldn't add a label post-PR creation, sorry about this |
Updating information on Tenderly platform
This PR adds clarifies or more info about using Tenderly in following areas:
No tested added, simple content update.
N/A