Skip to content

Conversation

@dslovinsky
Copy link
Collaborator

@dslovinsky dslovinsky commented Apr 18, 2025

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:

  • This does NOT address !include statements that import files from other aa-sdk repos. That will be done separately.
  • Twoslash support is not added yet, so pages containing those code snippets have broken MDX parsing
  • Unfortunately that means these changes can't be tested with preview links - you'd need to check locally

Pull Request Checklist


PR-Codex overview

This PR focuses on converting TypeScript files to Markdown files across various documentation pages, particularly for signer, config, and client related content. It replaces include statements with Markdown imports to enhance documentation clarity and accessibility.

Detailed summary

  • Deleted TypeScript files: signer.ts, account-provider-setup.tsx, supported-permissions.ts.
  • Converted config.ts, ssr-config.ts, client.ts, and others to .mdx format.
  • Replaced // [!include ...] statements with <Markdown src="..."/> in multiple .mdx files.
  • Updated paths in various documentation files to point to new .mdx files for better modularity and readability.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@vercel
Copy link

vercel bot commented Apr 18, 2025

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

Name Status Preview Comments Updated (UTC)
aa-sdk-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 8:13pm
aa-sdk-ui-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2025 8:13pm

@graphite-app
Copy link
Contributor

graphite-app bot commented Apr 18, 2025

How to use the Graphite Merge Queue

Add 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.

@github-actions
Copy link

github-actions bot commented Apr 18, 2025

🌿 Documentation Preview

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Apr 22, 2025, 7:56 PM

@dslovinsky dslovinsky merged commit 3b5d25a into main Apr 23, 2025
8 checks passed
@dslovinsky dslovinsky deleted the ds/fix-include-statements branch April 23, 2025 14:30
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.

2 participants