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

Add basic beginner tutorial #1202

Closed
alexandratran opened this issue Mar 8, 2024 · 4 comments · Fixed by #1276
Closed

Add basic beginner tutorial #1202

alexandratran opened this issue Mar 8, 2024 · 4 comments · Fixed by #1276
Assignees
Labels
tech-writing Requires updates to documentation content. wallet Related to wallet content.

Comments

@alexandratran
Copy link
Contributor

alexandratran commented Mar 8, 2024

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 alexandratran added wallet Related to wallet content. tech-writing Requires updates to documentation content. labels Mar 8, 2024
@subhamkumarr
Copy link
Contributor

subhamkumarr commented Mar 10, 2024

@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.

@BboyAkers
Copy link
Collaborator

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

@alexandratran
Copy link
Contributor Author

@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)?

@joaniefromtheblock
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech-writing Requires updates to documentation content. wallet Related to wallet content.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants