docs: clarify deprecated Snap Functions API - #3012
Open
Serjik-Developer wants to merge 1 commit into
Open
Conversation
|
Someone 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
1 participant
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.
Fixes #2894.
The Functions tab in the Snaps quickstart is marked deprecated, but the example did not explain what that means. Add a warning that JSX is recommended for new Snaps and that the function-based API is retained for legacy projects.
Verification:
npm run buildsucceeds. The existing build emits unrelated dependency and Sass deprecation warnings.Note
Low Risk
Documentation-only change with no runtime or API impact.
Overview
Adds a warning admonition at the top of the deprecated Functions tab in the Snaps quickstart so readers know the function-based custom UI API is deprecated, JSX is the path for new Snaps, and the tab remains for legacy examples only.
This aligns with issue #2894, where the tab was already marked deprecated but lacked an in-page explanation.
Reviewed by Cursor Bugbot for commit 8b7705d. Bugbot is set up for automated code reviews on this repo. Configure here.