-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add SDK docs #129
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
feat: add SDK docs #129
Conversation
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 |
Reviewer's Guide by SourceryThis 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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.
Summary by Sourcery
Documentation: