Skip to content

Conversation

@janb87
Copy link
Contributor

@janb87 janb87 commented Jan 13, 2025

Summary by Sourcery

Documentation:

  • Document the SettleMint SDK, a toolkit designed to simplify blockchain integration into applications.

@linear
Copy link

linear bot commented Jan 13, 2025

ENG-2172 Update SDK documentation link and add Table of Contents

jan on https://github.com/settlemint/sdk i think the link to Documentation should point to the page in the docs about the SDK (which i assume then points back to github) and i think we should have a ToC on there as well with the different packages

settlemint/sdk

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 13, 2025

Reviewer's Guide by Sourcery

This pull request introduces documentation for the SettleMint SDK. It adds a new section to the Development Tools page that links to a dedicated SDK page. The SDK page provides an overview of the SDK, its features, and a link to the SDK GitHub repository.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for the SettleMint SDK.
  • Added a new section to the Development Tools page that introduces the SDK and links to the dedicated SDK page.
  • Created a new SDK page that provides an overview of the SDK, its features (comprehensive integration, modular architecture, developer experience, enterprise readiness, type safety), and a link to the SDK GitHub repository.
  • Included licensing information for the SDK on the SDK page.
docs/using-platform/15_dev-tools/15_dev-tools.md
docs/using-platform/15_dev-tools/1_SDK.md

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 Jan 13, 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 - here's some feedback:

Overall Comments:

  • The heading level for 'Code studio' was changed from ### to ##. Please ensure heading levels are used consistently throughout the documentation.
  • There's an inconsistency in the GitHub repository URLs: 'settlemint-sdk' vs 'sdk'. Please verify and use the correct repository name consistently.
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

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) January 13, 2025 15:12
@janb87 janb87 merged commit 9b23898 into main Jan 14, 2025
2 checks passed
@janb87 janb87 deleted the jan/eng-2172-update-sdk-documentation-link-and-add-table-of-contents branch January 14, 2025 13:54
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.

3 participants