-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
docs(1367): tidy up for tutorials #1401
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
Minor suggestions, otherwise LGTM
proof Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
proof Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
proof Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
yarn install is fine for yarn path, but need alt for the npm ... |
Ziad suggesting that as yarn is the only install that will work, we should just remove the npm and npx options >> need to apply |
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.
LGTM
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
Signed-off-by: m4sterbunny <harrie.bickle@consensys.net>
proof Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
proof Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
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.
Additional comments.
"type": "git", | ||
"url": "https://github.com/MetaMask/template-snap-monorepo.git" | ||
}, |
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.
OK, I see this comment here now. I prefer just the relevant fragments. I find the tabs with the full file a bit confusing. If it makes sense, you can add an ellipses "..." before the closing bracket to denote additional text.
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.
Added final edits for syntax, style, and consistency.
Description
This update attempts to allow both tutorials to be a quick "hello world" AND to present best practice // further considerations that a serious snaps dev needs
Both tutorials:
Makes clear that icon step is optional (although recommended) -- adds optional steps that allow all UX to match tutorial function. Improves numbering of 5 and removes 6 (not a step)
Zaid also improved the referenced icon to be visible in dark mode
Issue(s) fixed
Fixes #1367