Skip to content

Conversation

bl0up
Copy link
Contributor

@bl0up bl0up commented Jun 3, 2025

Summary by Sourcery

Update the Graph middleware guide to use the correct data source list format in the manifest and fix sample code import paths to point to the right generated folder.

Bug Fixes:

  • Update sample code imports to reference the correct "generated/generated" directory for schema and API files.

Enhancements:

  • Convert the manifest YAML to a list-based dataSources format with proper indentation and dash prefixes.

Copy link

sourcery-ai bot commented Jun 3, 2025

Reviewer's Guide

This PR standardizes the Graph middleware manifest snippet by converting the contract block into a YAML list item with tightened placeholder formatting, and updates example import paths to the new “generated/generated” directory structure for consistency.

File-Level Changes

Change Details Files
Reformatted the middleware manifest snippet as a YAML list item with consistent placeholder syntax
  • Added a leading hyphen to the contract block to denote a list item
  • Adjusted indentation of mapping fields to align under the list item
  • Removed spaces inside placeholder braces (e.g. { id } → {id})
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx
Updated example import paths to reflect new generated directory layout
  • Changed imports from “../../generated/userdata/UserData” to “../../generated/generated/userdata/UserData”
  • Changed imports from “../../generated/schema” to “../../generated/generated/schema”
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bl0up bl0up requested a review from gyan-sharma June 3, 2025 12:53
@github-actions github-actions bot added the fix Bug fix label Jun 3, 2025
Copy link

coderabbitai bot commented Jun 3, 2025

Walkthrough

The update corrects YAML formatting in a manifest example by converting it to a properly formatted list and adjusting indentation. Additionally, TypeScript code snippets are modified to update import paths for generated files, reflecting an added directory level. No logic or exported entity declarations are changed.

Changes

File(s) Change Summary
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx Fixed YAML manifest formatting and indentation; updated TypeScript import paths for generated files

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to formatting and import path corrections.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 10ad6af and 73e26f0.

📒 Files selected for processing (1)
  • content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build
🔇 Additional comments (4)
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx (4)

176-202: Approve manifest YAML update
The example has been correctly converted into a YAML list with proper indentation and cleaned-up placeholder syntax, making it more idiomatic and easier to follow.


290-294: Verify updated import path for generated UserData
The import was changed to "../../generated/generated/userdata/UserData". Please confirm that this aligns with the actual directory structure after the PR (i.e., that there really is a nested generated/generated/userdata folder) and that the snippet will resolve correctly in users’ code.


295-299: Verify updated import path for generated schema
Similarly, the schema import now points to "../../generated/generated/schema". Double-check that this mirrors the on-disk layout and doesn’t introduce redundant nesting that could confuse readers or break copy-paste usage.


374-376: Verify fetch utility import path
The fetch/userdata.ts helper is importing UserProfile from "../../generated/generated/schema". Ensure this path correctly reflects where schema.ts is generated and that the helper snippet remains valid.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @bl0up - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gyan-sharma gyan-sharma merged commit 2a247e6 into main Jun 4, 2025
3 checks passed
@gyan-sharma gyan-sharma deleted the fix/subgraph branch June 4, 2025 09:42
@coderabbitai coderabbitai bot mentioned this pull request Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix Bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants