MetaMask / MetaMask/metamask-docs
Quickstart page doesn't clarify that the Functions tab uses a deprecated API
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 861
- Forks
- 2.1k
- Avg merge
- 6d 10h
- Merged PRs (30d)
- 10
Description
## Description
The Snaps quickstart page shows two code examples — JSX and Functions.
The "Functions" tab uses `panel()` and `text()` from `@metamask/snaps-sdk`,
which is the older deprecated approach. However, there is no note or warning
telling readers that the JSX approach is preferred and the Functions API
is legacy/deprecated.
## Page URL
https://docs.metamask.io/snaps/get-started/quickstart/
## Expected behavior
Add a deprecation note or warning on the "Functions" tab making it clear
that JSX is the recommended approach for new Snaps, and that the
Functions-based API is maintained for legacy purposes only.
## Why this matters
New developers copying the Functions example may use a deprecated pattern
without realizing it, leading to confusion later.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Snaps quickstart page at https://docs.metamask.io/snaps/get-started/quickstart/ and inspect the Functions tab alongside the JSX example. Add a clear deprecation note stating that JSX is recommended for new Snaps and the Functions API is retained for legacy use. Done means readers can identify the Functions example as deprecated before copying it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100