fix: update mdx imports in docs to use Markdown component from Fern #1525
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
How to use the Graphite Merge QueueAdd the label graphite-merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
🌿 Documentation Preview
|
dslovinsky
requested review from
moldy530,
rthomare,
dancoombs,
dphilipson,
linnall,
adamegyed,
howydev,
Zer0dot,
jaypaik,
Blu-J,
jakehobbs,
avarobinson,
florrdv and
blakecduncan
as code owners
blakecduncan
approved these changes
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
Currently a handful of pages are broken like the ones on authentication. Apparently this was caused by MDX files directly imported into other MDX files. Fern uses a Markdown component for reusable snippets, so this PR migrates all instances of imported mdx files to use that component.
I've only tested a subset of these pages but they've all worked so far. We'll do a more thorough check during QA phase.
Pull Request Checklist
yarn test)sitefolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)yarn lint:check) and fix any issues? (yarn lint:write)PR-Codex overview
This PR focuses on updating various documentation files to replace the usage of the
Snippetcomponent with theMarkdowncomponent for better consistency and clarity in the documentation.Detailed summary
<Snippet />with<Markdown src="..." />in multiple.mdxfiles.index.mdxdrop-and-replace.mdxauthenticating-with-social-auth.mdxauthenticating-with-magic-link.mdxquickstart.mdxauthenticating-with-otp.mdxgetting-started-rn-bare.mdxgetting-started-expo.mdxpasskey-signup.mdxsetting-up-the-accounts-provider.mdxreact-quickstart.mdxsetup-guide.mdxoverview.mdxsponsor-gas.mdxemail-otp.mdxemail-magic-link.mdxhow-to-set-up-smart-account-client.mdxlogin-methods/email-login.mdxlogin-methods/social-login.mdxlogin-methods/passkey-login.mdxlogin-methods/social-providers.mdxreact-hooks.mdxgetting-started.mdxterms.mdx