Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add info on tenderly #58

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

nvitorovic
Copy link

@nvitorovic nvitorovic commented Feb 27, 2025

This PR adds info about Tenderly in relevant pages:

  • rpc providers
  • block explorers
  • monitoring (newly created)

Summary by CodeRabbit

  • Documentation
    • Introduced a new Monitoring guide that explains how to track smart contract interactions with alerts, custom notifications, automated responses, and proactive transaction simulations.
    • Updated service descriptions to clearly outline enhanced provider offerings including development, testing, staging, and monitoring tools.
    • Added a Developer Explorer section detailing debugging and alert management capabilities.
    • Improved navigation within the developer resources for easier access to monitoring and security tools.

@nvitorovic nvitorovic requested a review from a team as a code owner February 27, 2025 12:05
@nvitorovic nvitorovic requested a review from r3aker86 February 27, 2025 12:05
Copy link

coderabbitai bot commented Feb 27, 2025

Walkthrough

This pull request introduces a new "Monitoring" documentation file that details Tenderly’s monitoring and security solutions for the Morph ecosystem. The update expands the description of Tenderly services in the RPC services document by clarifying service roles and updating call-to-action links with tracking parameters. Additionally, a new "Tenderly Developer Explorer" section with supporting visuals has been added to the Block Explorer document. Finally, the developer sidebar has been updated to include an entry for the new Monitoring documentation.

Changes

File(s) Change Summary
docs/.../10-monitoring.md, sidebars.js Added a new "Monitoring" documentation file outlining Tenderly’s monitoring & security features, and updated the developer sidebar to include a link to this new resource.
docs/.../2-rpc-services.md, docs/.../6-block-explorer.md Revised the description of Tenderly services with expanded roles and updated links in the RPC services doc; added a new "Tenderly Developer Explorer" section (with images) in the Block Explorer doc.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant API as Tenderly Alerts API
    participant SC as Smart Contract
    participant WH as External Webhook

    Dev->>API: Configure Alert (set criteria)
    SC->>API: Emit Contract Event
    API->>Dev: Send Notification
    API->>WH: Trigger Webhook Alert
    WH-->>Dev: Confirm Receipt
Loading

Poem

I'm a bunny with a hop in my stride,
Leaping through docs, full of wondrous pride.
New monitoring pages make my ears stand tall,
Tenderly updates answer every call.
Hoppy changes abound—let's code and have a ball!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

@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 (1)
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/10-monitoring.md (1)

8-10: Minor grammatical error in the introduction.

There's a small grammatical error in the text.

- Tenderly provides comprehensive monitoring and security solutions for Morph, allowing you to stay in loop with smart contract interactions and respond proactively to potential issues. 
+ Tenderly provides comprehensive monitoring and security solutions for Morph, allowing you to stay in the loop with smart contract interactions and respond proactively to potential issues. 
🧰 Tools
🪛 LanguageTool

[uncategorized] ~10-~10: Possible missing article found.
Context: ...ions for Morph, allowing you to stay in loop with smart contract interactions and re...

(AI_HYDRA_LEO_MISSING_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27d794c and 9171a53.

⛔ Files ignored due to path filters (2)
  • assets/docs/dev/resources/tenderly-dev-explorer.png is excluded by !**/*.png
  • assets/docs/dev/resources/tenderly.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/10-monitoring.md (1 hunks)
  • docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/2-rpc-services.md (1 hunks)
  • docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/6-block-explorer.md (1 hunks)
  • sidebars.js (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/2-rpc-services.md
🧰 Additional context used
🪛 LanguageTool
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/10-monitoring.md

[uncategorized] ~10-~10: Possible missing article found.
Context: ...ions for Morph, allowing you to stay in loop with smart contract interactions and re...

(AI_HYDRA_LEO_MISSING_THE)

🔇 Additional comments (5)
sidebars.js (1)

249-252: LGTM - Sidebar entry for new Monitoring section added correctly.

The new monitoring entry follows the established pattern for documentation links and is correctly placed within the "Use Ecosystem Developer Tools" category.

docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/6-block-explorer.md (2)

12-13: Image path looks good.

The image path for the socialscan explorer follows the proper convention.


14-18: New Tenderly Developer Explorer section is well structured.

The section provides valuable information about Tenderly's Developer Explorer capabilities for Morph projects, including links to relevant documentation for alerts and Virtual TestNets. The image inclusion with a descriptive alt text enhances the user's understanding of the feature.

docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/10-monitoring.md (2)

1-7: New Monitoring document setup looks good.

The frontmatter and main heading are correctly structured, following the documentation standards.


12-15: Feature list is comprehensive and well-structured.

The bullet points provide a good overview of Tenderly's monitoring capabilities, with appropriate links to more detailed documentation for each feature.

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.

1 participant