Skip to content

Format filenames in embedded-wallets and add redirects in Readme.md and vercel.json#2872

Merged
bgravenorst merged 10 commits intoMetaMask:mainfrom
swastik7805:2863/filename-change
Apr 20, 2026
Merged

Format filenames in embedded-wallets and add redirects in Readme.md and vercel.json#2872
bgravenorst merged 10 commits intoMetaMask:mainfrom
swastik7805:2863/filename-change

Conversation

@swastik7805
Copy link
Copy Markdown
Contributor

@swastik7805 swastik7805 commented Apr 17, 2026

Description

This PR refactors filename conventions in the embedded-wallets/sdk/ directory to satisfy the markdown-formatting.mdc guideline (lowercase letters and dashes only).

Previously, many files in the usage/ sections used camelCase names that mirrored technical API methods. This PR standardizes them across all SDK platforms (iOS, Android, React Native, Flutter, Unity, Unreal, and JS).

Key Changes:

  • File Renames: Moved ~55 .mdx files from camelCase to kebab-case (e.g., getUserInfo.mdxget-user-info.mdx, enableMFA.mdxenable-mfa.mdx).
  • Sidebar Update: Updated ew-sidebar.js config to point to the new lowercase-dashed paths.
  • Redirects: Added 301 redirects in vercel.json for every renamed path to prevent broken links for users with bookmarks or external references.
  • Internal Link Cleanup: Performed a repository-wide search and replace to update all relative internal links referencing the old filenames in Readme.md.

Issue(s) fixed

Fixes #2863 proposed by @bgravenorst .

Preview

The changes impact the URL structure of the "Usage" section across all Embedded Wallets SDKs. Redirects have been verified in vercel.json.

Before:

image

After:

image

Checklist

  • If this PR updates or adds documentation content that changes or adds technical meaning, it has received an approval from an engineer or DevRel from the relevant team.
  • If this PR updates or adds documentation content, it has received an approval from a technical writer.

External contributor checklist

  • I've read the contribution guidelines.
  • I've created a new issue (or assigned myself to an existing issue) describing what this PR addresses.

Note

Medium Risk
Mostly documentation routing changes, but it touches many URLs and relies on comprehensive redirects; any missed mapping could cause broken links or sidebar 404s.

Overview
Standardizes Embedded Wallets SDK usage doc slugs across Android, iOS, Flutter, React Native, Unity, Unreal, and JS by switching function-page links from camelCase to kebab-case in each platform usage/README.mdx.

Updates the Docusaurus sidebar (ew-sidebar.js) to reference the new kebab-case doc IDs, and adds permanent (301) Vercel redirects in vercel.json from the old camelCase routes to the new kebab-case routes to avoid breaking existing inbound links.

Reviewed by Cursor Bugbot for commit 099ebee. Bugbot is set up for automated code reviews on this repo. Configure here.

@swastik7805 swastik7805 requested review from a team as code owners April 17, 2026 18:05
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 17, 2026

@swastik7805 is attempting to deploy a commit to the Consensys Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Reviewed by Cursor Bugbot for commit 20c4471. Configure here.

Comment thread vercel.json Outdated
@swastik7805
Copy link
Copy Markdown
Contributor Author

@bgravenorst @alexandratran @AyushBherwani1998 @yashovardhan hey guys, i have fixed issue #2863 by updating filenames as per markdown-formatting.mdc and update redirect links in respective Readme.md and vercel.json.
Also resolved the phantom redirects as stated by cursor-bit.

PR is updated and ready for review.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
metamask-docs Ready Ready Preview, Comment Apr 20, 2026 0:21am

Request Review

Copy link
Copy Markdown
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @swastik7805 🚀

@bgravenorst bgravenorst merged commit a381e90 into MetaMask:main Apr 20, 2026
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename camelCase filenames to lowercase-dashes in Embedded Wallets SDK

2 participants