Skip to content
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

Merged
merged 63 commits into from
Aug 2, 2024
Merged

docs(1367): tidy up for tutorials #1401

merged 63 commits into from
Aug 2, 2024

Conversation

m4sterbunny
Copy link
Contributor

@m4sterbunny m4sterbunny commented Jul 10, 2024

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

@m4sterbunny m4sterbunny requested review from a team as code owners July 10, 2024 12:26
Copy link

vercel bot commented Jul 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2024 4:45pm

alexandratran
alexandratran previously approved these changes Jul 10, 2024
Copy link
Contributor

@alexandratran alexandratran left a 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

m4sterbunny and others added 4 commits July 22, 2024 14:46
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>
@m4sterbunny
Copy link
Contributor Author

yarn install is fine for yarn path, but need alt for the npm ...

@m4sterbunny m4sterbunny marked this pull request as ready for review July 22, 2024 14:39
@m4sterbunny m4sterbunny marked this pull request as draft July 22, 2024 16:04
@m4sterbunny
Copy link
Contributor Author

Ziad suggesting that as yarn is the only install that will work, we should just remove the npm and npx options >> need to apply

alexandratran
alexandratran previously approved these changes Jul 22, 2024
Copy link
Contributor

@alexandratran alexandratran left a 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>
@m4sterbunny m4sterbunny marked this pull request as ready for review July 24, 2024 16:42
@m4sterbunny m4sterbunny marked this pull request as draft July 24, 2024 16:43
m4sterbunny and others added 2 commits July 31, 2024 08:06
proof

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
proof

Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

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

Additional comments.

Comment on lines 162 to 164
"type": "git",
"url": "https://github.com/MetaMask/template-snap-monorepo.git"
},
Copy link
Contributor

@alexandratran alexandratran Jul 31, 2024

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.

alexandratran
alexandratran previously approved these changes Aug 2, 2024
Copy link
Contributor

@alexandratran alexandratran left a 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.

@alexandratran alexandratran merged commit a90976a into main Aug 2, 2024
9 checks passed
@alexandratran alexandratran deleted the 1367-tabs-for-options branch August 2, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tab code options for yarn::npx::npm in tutorials
3 participants