Skip to content

Conversation

@dslovinsky
Copy link
Collaborator

@dslovinsky dslovinsky commented Apr 25, 2025

Context

!include statements to directly reference code in docs snippets is a vocs feature that Fern doesn't support. Fern has told us to just remove the references and maintain the code snippets directly in MDX. But fuck that

Tada 🎉 , working !include statements. No MDX file changes necessary.

Before:
image
After:
image

Pull Request Checklist


PR-Codex overview

This PR introduces a new GitHub Action to extract code snippets from specified files and updates documentation to include instructions for using these snippets.

Detailed summary

  • Added a new step in .github/actions/setup-docs/action.yml to extract code snippets using a script.
  • Updated docs/README.md to clarify how to generate SDK references and introduced a section on injected code snippets.
  • Created docs/scripts/extract-include-statements.js to find and replace [!include] statements in .mdx files with actual code content.

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

@vercel
Copy link

vercel bot commented Apr 25, 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 28, 2025 6:48pm
aa-sdk-ui-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 28, 2025 6:48pm

@graphite-app
Copy link
Contributor

graphite-app bot commented Apr 25, 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 25, 2025

🌿 Documentation Preview

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Apr 28, 2025, 6:32 PM

@github-actions github-actions bot temporarily deployed to docs-preview April 28, 2025 18:31 Inactive
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