Skip to content

POC for new flow of documentation #2179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 39 commits into
base: main
Choose a base branch
from
Open

POC for new flow of documentation #2179

wants to merge 39 commits into from

Conversation

yashovardhan
Copy link
Member

Adds the following:

  • Adds playground based on Web3Auth Quick Start
  • Add highlighting and blur magic comments
  • Update home page
  • Update nav bar components

Max time was spent on maintaining the same design scheme, although a design review will be ideal

@yashovardhan yashovardhan requested review from a team as code owners July 28, 2025 09:47
Copy link

vercel bot commented Jul 28, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
metamask-docs Failed Aug 12, 2025 10:15pm

Copy link

socket-security bot commented Jul 28, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addedcopy-to-clipboard@​3.3.31001009176100
Addedclassnames@​2.5.110010010079100
Addedreact-spring@​10.0.1991009982100
Addedreact-spinners@​0.17.010010010083100
Addedreact-icons@​5.5.01001001008480

View full report

@yashovardhan yashovardhan requested review from a team as code owners July 29, 2025 17:41
cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@yashovardhan yashovardhan requested a review from a team as a code owner July 30, 2025 04:54
cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

files[qsFileLinks.EW_PNP_IOS_USERDETAILVIEW_SWIFT],
'Get User Info'
),
},
Copy link

Choose a reason for hiding this comment

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

Bug: Quick Start Builder UI Content Mismatch

The "Get User Info" step in the iOS Quick Start builder's highlightRange call incorrectly uses EW_PNP_IOS_VIEWMODEL_SWIFT as the filename while providing content from EW_PNP_IOS_USERDETAILVIEW_SWIFT. This mismatch causes the UI to display the wrong file's content and results in incorrect code highlighting for this step.

Fix in Cursor Fix in Web

let match;

// Reset regex lastIndex to avoid stateful issues
regex.lastIndex = 0;
Copy link

Choose a reason for hiding this comment

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

Bug: Unescaped User Input Causes Regex Errors

The highlightSearchText function constructs a RegExp directly from user searchInput without escaping special characters. This causes inputs like (, [, or + to throw an "Invalid regular expression" error, crashing the Guides card component. Escape search terms before building the regex to prevent runtime errors.

Fix in Cursor Fix in Web

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.

1 participant