-
Notifications
You must be signed in to change notification settings - Fork 199
docs: replace broken !include statements to shared TS files #1551
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
Conversation
…include-statements
|
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
|
…include-statements
Context:
[!include <filename>]is vocs syntax that doesn't work in Fern docs. Their code snippets don't allow for importing TS files directly into code snippets. This workaround uses Fern's Markdown component to import a MDX file instead which has a similar effect and should work once Fern implements twoslash.Notes for Reviewers:
!includestatements that import files from otheraa-sdkrepos. That will be done separately.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 converting TypeScript files to Markdown files across various documentation pages, particularly for
signer,config, andclientrelated content. It replaces include statements with Markdown imports to enhance documentation clarity and accessibility.Detailed summary
signer.ts,account-provider-setup.tsx,supported-permissions.ts.config.ts,ssr-config.ts,client.ts, and others to.mdxformat.// [!include ...]statements with<Markdown src="..."/>in multiple.mdxfiles..mdxfiles for better modularity and readability.