docs(services): improve Infura tutorials with MetaMask workflow and signing guidance#2936
Open
rohan911438 wants to merge 1 commit into
Open
docs(services): improve Infura tutorials with MetaMask workflow and signing guidance#2936rohan911438 wants to merge 1 commit into
rohan911438 wants to merge 1 commit into
Conversation
|
@rohan911438 is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1386
This PR refreshes several Services tutorials to provide clearer MetaMask context, improve workflow guidance, and align tutorial structure with existing MetaMask documentation standards.
What Changed
The following tutorials were updated:
use-web3.js.mdsend-a-transaction-ethers.mdsend-a-transaction-viem.mddeploy-a-contract-using-web3.js.mdcall-a-contract.mdlayer-2-networks/send-a-transaction.mdImprovements
Added MetaMask Context
Each tutorial now includes a short section explaining:
Clarified Signing and Broadcasting
Added standardized guidance describing:
Improved Security Guidance
Added warnings before private-key-based examples to clarify that:
Added Recommended MetaMask Workflows
Introduced a MetaMask-first workflow section that explains how developers can:
Added Network Selection Guidance
Added notes for tutorials using Sepolia, Polygon, and other EVM networks to help developers:
Why
Many tutorials focused primarily on Infura-based workflows and private-key-driven examples without clearly explaining how those workflows fit into a typical MetaMask development experience.
These updates provide a clearer mental model for developers by:
Testing
Note
Low Risk
Markdown-only documentation with no runtime or API changes; content improves security messaging for developers.
Overview
Six Infura Services Ethereum/Polygon tutorials gain shared MetaMask-oriented prose: relevance for dapp builders, network/RPC alignment checks, a signing vs broadcasting split (wallet signs locally; Infura RPC only), and a wallet-first flow (
eth_requestAccounts, injected provider/signer, user confirmation).Private-key examples (
.env,config.ts) are framed with:::warningblocks as local dev, test, or automation only, with production guidance to use in-browser wallet signing instead of exported keys. Tutorial steps and sample scripts are unchanged; updates are markdown-only.Reviewed by Cursor Bugbot for commit 69d2aa1. Bugbot is set up for automated code reviews on this repo. Configure here.