-
Notifications
You must be signed in to change notification settings - Fork 0
fix: atk-deployment-and-signup #286
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
Conversation
Reviewer's Guide by SourceryThis pull request includes changes to the Asset Tokenization Kit documentation, including renaming the main page to 'Introduction', adding new pages for 'Deployment' and 'Signup and Login', and updating the getting started guide with reordered steps and a new step for setting up private keys. The pull request also includes the deletion of the 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 @gyan-sharma - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a table of contents to the new
deployment.mdx
page for easier navigation. - The instructions in
getting-started.mdx
now have different numbering - double check that the links still work.
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
# Login and connect to SettleMint | ||
bunx settlemint login | ||
bunx settlemint connect |
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.
suggestion: Check for consistency in command usage across sections.
In the predeployed setup, the commands use 'bunx' while in the customized setup they use 'bun'. Unless this is an intentional distinction, consider unifying the command syntax to avoid confusion.
# Login and connect to SettleMint | |
bunx settlemint login | |
bunx settlemint connect | |
# Login and connect to SettleMint | |
bun settlemint login | |
bun settlemint connect |
|
||
Post login you will see the dashboard and will get access to various modules and services related to asset tokenization. | ||
|
||
 |
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.
suggestion: Enhance image alt text for improved clarity and accessibility.
Consider replacing the generic alt text 'dashboard' with a more descriptive phrase to better inform users utilizing screen readers.
atk-deployment-and-signup
Summary by Sourcery
Update documentation for Asset Tokenization Kit, adding detailed deployment, signup, and login instructions
Enhancements:
Documentation: