Skip to content

Conversation

gyan-sharma
Copy link
Contributor

@gyan-sharma gyan-sharma commented Apr 1, 2025

Summary by Sourcery

Update documentation for the Asset Tokenization Kit, including restructuring pages, updating links, and adding new documentation pages for deployment and signup processes.

Enhancements:

  • Renumbered steps in the getting started guide to accommodate a new initial step about setting up private keys
  • Simplified and clarified documentation structure for the Application Kits section

Documentation:

  • Restructured the Asset Tokenization Kit documentation with new pages for deployment and signup
  • Updated homepage and navigation links to reflect documentation changes
  • Added detailed deployment and setup instructions for the Asset Tokenization Kit

@gyan-sharma gyan-sharma self-assigned this Apr 1, 2025
Copy link

sourcery-ai bot commented Apr 1, 2025

Reviewer's Guide by Sourcery

This pull request includes several updates to the documentation, including adding a new step to the getting started guide, renaming the asset tokenization kit page, updating links, removing the meta.json file, and adding deployment and signup/login guides for the asset tokenization kit.

Updated Flow Diagram for Smart Contract Development

flowchart LR
    A[Start] --> B{Setup private keys and attach them to a node for Tx Signer}
    B --> C{Add Code Studio IDE}
    C --> D{Develop smart contract code}
    D --> E{Write test scripts and test contract}
    E --> F{Compile smart contract and get ABI}
    F --> G{Deploy contract to the network}
    G --> H{Note the deployed contract address}
    H --> I[End]

    style A fill:#f9f,stroke:#333,stroke-width:2px
    style I fill:#f9f,stroke:#333,stroke-width:2px
Loading

File-Level Changes

Change Details Files
Updated the 'getting started' guide to include a new step for setting up private keys and renumbered the subsequent steps.
  • Added a new step for setting up private keys and attaching them to a node for Tx Signer.
  • Renumbered the existing steps to accommodate the new step.
content/docs/building-with-settlemint/getting-started.mdx
Renamed the 'Asset tokenization kit' page to 'Introduction'.
  • Renamed the file from 'asset-tokenization-kit.mdx' to 'introduction.mdx'.
  • Updated the title of the page to 'Introduction'.
content/docs/application-kits/asset-tokenization/asset-tokenization-kit.mdx
content/docs/application-kits/asset-tokenization/introduction.mdx
Updated the link to the 'Aplication kits' page on the index page.
  • Changed the link from '/application-kits/asset-tokenization/asset-tokenization-kit' to '/application-kits/introduction'.
content/docs/index.mdx
Updated the link to the 'Asset Tokenization Kit' page on the application kits introduction page.
  • Changed the link from '/application-kits/asset-tokenization/asset-tokenization-kit' to '/application-kits/introduction'.
content/docs/application-kits/introduction.mdx
Removed the meta.json file.
  • Deleted the 'meta.json' file.
content/docs/application-kits/asset-tokenization/meta.json
Added a deployment guide for the asset tokenization kit.
  • Created a new 'deployment.mdx' file.
  • Added instructions for deploying the asset tokenization kit using both pre-deployed and customized setups.
  • Included steps for database customization.
content/docs/application-kits/asset-tokenization/deployment.mdx
Added a signup and login guide for the asset tokenization kit.
  • Created a new 'signup-and-login.mdx' file.
  • Added instructions for signing up and logging in to the asset tokenization kit.
  • Included information on accessing the connection endpoint and creating an admin account.
content/docs/application-kits/asset-tokenization/signup-and-login.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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

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 @gyan-sharma - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using more descriptive image alt text for accessibility.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 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.

@@ -10,6 +10,8 @@ Find the connection endpoint on the connect tab of the custom deployment Section
Go to issuer portal, sign up to create the admin or the issuer account. The first user to signup gets the admin rights to the application.
![Sign Up](../../../img/application-kits/sign-up.png)

You may also setup sign-in via a passkey.
Copy link

Choose a reason for hiding this comment

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

suggestion (typo): Consider rephrasing 'setup' to 'set up'.

Using the two-word phrasing 'set up' as a verb can improve clarity in the documentation.

Suggested change
You may also setup sign-in via a passkey.
You may also set up sign-in via a passkey.

@@ -731,7 +731,7 @@ SettleMint Application Kits are designed to dramatically accelerate the
development of enterprise blockchain applications by providing pre-packaged,
full-stack solutions inlculding both - smart contrcats and the dAPP UI for common use cases.

Read more - [Aplication kits](/application-kits/asset-tokenization/asset-tokenization-kit)
Copy link

Choose a reason for hiding this comment

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

nitpick (typo): Check the spelling of 'Aplication kits' in the hyperlink text.

It appears that 'Aplication' might be missing a 'p'. If this change wasn’t intentional, consider correcting it to 'Application kits'.

Suggested change
Read more - [Aplication kits](/application-kits/asset-tokenization/asset-tokenization-kit)
Read more - [Application kits](/application-kits/introduction)

@gyan-sharma gyan-sharma enabled auto-merge (squash) April 1, 2025 19:03
@gyan-sharma gyan-sharma merged commit 666f4ea into main Apr 1, 2025
2 checks passed
@gyan-sharma gyan-sharma deleted the gyan/homepage-atk-link-fix branch April 1, 2025 19:13
@github-actions github-actions bot added the fix Bug fix label Apr 1, 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