feat: replace synapse code snippet image with live twoslash-verified code block#284
Open
nijoe1 wants to merge 1 commit intoFilOzone:mainfrom
Open
feat: replace synapse code snippet image with live twoslash-verified code block#284nijoe1 wants to merge 1 commit intoFilOzone:mainfrom
nijoe1 wants to merge 1 commit intoFilOzone:mainfrom
Conversation
|
@nijoe1 is attempting to deploy a commit to the FilOz Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
📝 Description
Replaces the static
.webpimage of the Synapse SDK code snippet with a live, syntax-highlighted code block. The code is type-checked at build time using twoslash — if@filoz/synapse-sdkintroduces breaking API changes, the build fails. Also adds a cron-based GitHub Action to check for new SDK versions every 5 days.🛠️ Key Changes
<Image>with Shiki-highlighted code block, colors matched to original designcqi) — code block scales like an imagesynapse-sdk-check.ymlworkflow: auto-creates PR on compatible update, opens issue on breaking change📌 To-Do Before Merging
synapse-sdk-updatelabel for the automated issue workflow🧪 How to Test
npm install && npm run buildnpm run devand navigate to/warm-storage-servicesynapse-code-snippet.ts(e.g. rename.uploadto.uploadX) and runnpm run build— should fail with a type errorworkflow_dispatch📸 Screenshots
🔖 Resources
cqiunits)