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

Add basic beginner tutorial

Open alexandratran opened this issue 1 year ago • 4 comments

With removing the quickstarts and emphasizing the EIP-6963 content in #1197, we need a very basic tutorial in vanilla JS without EIP-6963 that a beginner can use as a simple learning exercise and a way to connect very quickly with minimal code and minimal background knowledge. This tutorial can include caveats that we recommend using EIP-6963 and build tools such as Vite in production.


This tutorial can combine the instructions from:

Note that in the code samples, provider should be replaced with window.ethereum since it doesn't use EIP-6963.

Make sure to provide context that this tutorial is meant to only be a learning experience for building a minimal dapp that connects to MetaMask. In production, we recommend using EIP-6963 (point to the Connect guide).

We can link to this tutorial from the intro page and in an admonition on the Connect page.

alexandratran avatar Mar 08 '24 23:03 alexandratran

@alexandratran, ma'am, I want to work on this.

These are the changes I need to do in this issue?

  1. Removal of Quickstart Section: The existing Quickstart section will be removed from the documentation.

  2. Updating the "Detect Wallet" Section: This section will be renamed to "Connect to MetaMask", it will emphasize the use of EIP-6963 as the primary method for connecting to MetaMask, whether directly or through a third-party library.

  3. Adding EIP-6963 Code Examples for Vanilla JS: New code examples will be added to demonstrate how to implement EIP-6963 in vanilla JavaScript.

subhamkumarr avatar Mar 10 '24 04:03 subhamkumarr

Oooo is this still needing to be worked on?? 👀👀👀 If so I'd be down to do it!

BboyAkers avatar Apr 13 '24 03:04 BboyAkers

@BboyAkers Thanks for asking, but I think our tech writer @joaniefromtheblock is working on this. @joaniefromtheblock Can you confirm that you're currently working on this, otherwise we could give it to @BboyAkers (who has worked on this repo in the past)?

alexandratran avatar Apr 13 '24 06:04 alexandratran

Hi @BboyAkers! I am working on this; hoping to get a PR in soon

joaniekube avatar Apr 15 '24 15:04 joaniekube