-
Notifications
You must be signed in to change notification settings - Fork 200
build: create script for processing include statements in docs #1568
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
|
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
|
Context
!includestatements 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 thatTada 🎉 , working !include statements. No MDX file changes necessary.
Before:


After:
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 introduces a new GitHub Action to extract code snippets from specified files and updates documentation to include instructions for using these snippets.
Detailed summary
.github/actions/setup-docs/action.ymlto extract code snippets using a script.docs/README.mdto clarify how to generate SDK references and introduced a section on injected code snippets.docs/scripts/extract-include-statements.jsto find and replace[!include]statements in.mdxfiles with actual code content.