docs: clarify legacy Functions API in Snaps quickstart#2980
Open
Root-Aamir wants to merge 2 commits into
Open
Conversation
|
@Root-Aamir is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
Nonthawat100iQ
approved these changes
Jul 10, 2026
Nonthawat100iQ
left a comment
Nonthawat100iQ
left a comment
There was a problem hiding this comment.
0x8B8E68D5C61D4d31297c9984f571ADB79f4aE473
Author
|
Hi, just checking if anything else is needed from my side. The PR only updates the Snaps quickstart documentation note and is ready for review when maintainers have time. |
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
2 participants
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
Adds a short note to the Snaps quickstart page clarifying that the Functions tab uses the legacy/deprecated Functions-based UI API (
panel()andtext()from@metamask/snaps-sdk).This also clarifies that JSX is recommended for new Snaps, while the Functions API is maintained for legacy examples.
Issue(s) fixed
Fixes #2894
Preview
Updated page:
https://docs.metamask.io/snaps/get-started/quickstart/
Checklist
Note
Low Risk
Documentation-only wording on one page; no runtime or API behavior changes.
Overview
Adds a Docusaurus note callout at the top of the Functions tab in the Snaps quickstart Customize the Snap example.
The note states that tab documents the legacy/deprecated
panel()/text()UI API from@metamask/snaps-sdk, directs new Snaps to the JSX tab, and explains the Functions sample remains for legacy examples. No code samples or other docs pages are changed.Reviewed by Cursor Bugbot for commit 8f618b7. Bugbot is set up for automated code reviews on this repo. Configure here.