metamask-docs icon indicating copy to clipboard operation
metamask-docs copied to clipboard

WIP: Starknet Snap docs

Open joaniekube opened this issue 1 year ago • 4 comments

Description

Draft of Starknet Snap docs.

Issue(s) fixed

Fixes #1511
Fixes #1512 Fixes #1513 Fixes #1514 Fixes #1515 Fixes #1516 Fixes #1526

Preview

Preview: https://metamask-docs-q7zj4ehq0-metamask-web.vercel.app/wallet/how-to/use-non-evm-networks/ (If out of date, see the Vercel link at the bottom of the PR activity for the latest preview.)

Checklist

Complete this checklist before merging your PR:

  • [ ] If this PR contains a major change to the documentation content, I have added an entry to the top of the "What's new?" page.
  • [ ] The proposed changes have been reviewed and approved by a member of the documentation team.

joaniekube avatar Aug 28 '24 17:08 joaniekube

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

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 18 resolved Oct 18, 2024 5:58pm

vercel[bot] avatar Aug 28 '24 17:08 vercel[bot]

Some notes on connect vs install:

  • We are moving away from using the term "install" with Snaps. We prefer "add" such as "add to MetaMask."
  • For the dapp, the primary action to initiate interacting with Starknet accounts is to connect to the Snap, just like a dapp connects with MetaMask to interact with Ethereum accounts. Whether the user has the Starknet Snap installed already is not important. If the user needs to install the Snap, they will be prompted to do so.
    • Despite this, we do need to explain that the user can reject the prompt to add the Snap to MetaMask and document what to expect (the response that the dapp will receive if the user rejects the request) and encourage the dapp to do something in that instance, like display a message to the user that they need to add the Snap to MetaMask in order to proceed.
    • Also, in terms of working with Starknet specifically, we may need to explain that a user will need to take some steps to set up a Starknet account before they can actually use it with the dapp, so the dapp should thoughtfully design that onboarding flow. Whether the user needs to add the Snap (and thus they will be completely new to Starknet) or they already have it but their account is not funded or deployed, the dapp should handle those scenarios.

Montoya avatar Sep 06 '24 19:09 Montoya

Added more comments. Some are high-level – I will return to certain pages when they're more copy-edit ready.

Okay sorry, I still didn't push changes for the tutorial and troubleshoot sections; thought I mentioned during our sync

joaniekube avatar Sep 19 '24 12:09 joaniekube

@alexandratran pushed changes and suggestions, but am still working on tutorial and troubleshoot section. I ran into some issues/ errors when trying to replicate the steps for the tutorial.

joaniekube avatar Sep 19 '24 19:09 joaniekube

Still to do

Hi @khanti42, these are some action items (outstanding tasks) raised from our sync on Friday ( I might have missed a few, so please add if I forgot something):

  • [x] Review wallet_invokeSnap code samples added to guide pages
  • [x] Follow up on API methods that were flagged
  • [x] Confirm tutorial steps
  • [x] Investigation or decision on incorporating EIP-6963 (You mentioned this may be a Phase II activity)

So things @joaniefromtheblock needs to work on in the meanwhile:

  • [x] Add screenshot for Snap connection
  • [x] Adding screenshots for tutorial (if the build works)
  • [x] Add note related to EIP-6963
  • [ ] Add token content to send transaction guide
  • [x] Add wallet_invokeSnap alternative for all guides
  • [x] Resolve all Vercel comments
  • [x] Make draft timeline for docs release

joaniekube avatar Sep 30 '24 10:09 joaniekube

I force pushed changes, which apparently undid the changes I made previously and Florin's commits that I accepted.

joaniekube avatar Oct 16 '24 08:10 joaniekube