Skip to content

Conversation

janb87
Copy link
Contributor

@janb87 janb87 commented May 15, 2025

Summary by Sourcery

Add Ethereum Attestation Service (EAS) integration support to the SettleMint SDK documentation and configuration.

Enhancements:

  • Include @settlemint/sdk-eas as a recognized SDK component in the documentation overview.
  • Update the documentation generator to process the README for @settlemint/sdk-eas.

Documentation:

  • Add a new eas.mdx guide for EAS integration.
  • Include @settlemint/sdk-eas entry in the SDK components table.
  • Embed the generated EAS documentation snippet in the platform docs.

@janb87 janb87 requested a review from robbeverhelst May 15, 2025 16:14
Copy link

sourcery-ai bot commented May 15, 2025

Reviewer's Guide

This PR enhances the SettleMint SDK documentation by integrating the Ethereum Attestation Service (EAS) module. It updates the documentation generation script to include EAS snippets, registers the new SDK package in the overview table, adds the EAS dependency to the project, and provides a dedicated EAS docs page.

File-Level Changes

Change Details Files
Added snippet generation support for EAS docs
  • Invoked generateSnippet for sdk-eas README to create EAS snippet
scripts/generate-sdk-docs.ts
Registered @settlemint/sdk-eas in the SDK overview
  • Inserted EAS module row in the SDK table with npm badge and description
content/docs/platform-components/dev-tools/sdk.mdx
Added EAS SDK dependency
  • Added @settlemint/sdk-eas@2.2.3 to package.json
  • Updated bun.lock to include the new package resolution
package.json
bun.lock
Introduced new EAS documentation page
  • Created eas.mdx with frontmatter and snippet include
content/docs/building-with-settlemint/building-with-sdk/eas.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

@github-actions github-actions bot added the feat New feature label May 15, 2025
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 @janb87 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: 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.

@janb87 janb87 enabled auto-merge (squash) May 16, 2025 06:43
@janb87 janb87 merged commit 07cc9a1 into main May 16, 2025
2 checks passed
@janb87 janb87 deleted the jan/update-sdk branch May 16, 2025 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants