feat: embed the Swarm cheatsheet, synced from swarm-cheatsheets#829
Merged
Conversation
- add scripts/fetch-cheatsheets.mjs to fetch the cheatsheet page, assets, and PDF from swarm-cheatsheets@main and mirror them into static/cheatsheets/ with asset paths rewritten - fetch files concurrently with a per-request timeout, prune the output dir first, and fail the build on any fetch error - wire the script into the prebuild chain and gitignore the generated static/cheatsheets output Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
- add tools-and-features/cheatsheets page that embeds the mirrored cheatsheet via iframe and register it in the sidebar - add a Swarm Cheatsheet card to the Setup section of the Start Building page - add an llms.txt pointer to the self-hosted cheatsheet for agents Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
✅ Deploy Preview for test-twitter-preview-testing-3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
GasperX93
approved these changes
Jul 16, 2026
- grow the iframe to its content height on load so the page scrolls instead of the iframe - re-measure with a ResizeObserver to track reflow after fonts load and QR codes render - keep an 85vh min-height as a no-JS fallback Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
- mirror cheatsheet.html (the A4 card) instead of index.html, dropping the source site's chrome, toolbar, and footer from the embed - stop mirroring the chrome-only swarm-logo-white.svg - replace the card's removed Download PDF button with Download PDF and open-in-new-tab links on the doc page Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
- scale the fixed A4 card to fill the doc content column, removing the grey margins beside the centered sheet and enlarging it a bit - size the wrapper to the scaled height so the page scrolls, refitting on reflow and window resize - remove the redundant open-in-new-tab link Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
yjkellyjoo
force-pushed
the
feat/embed-swarm-cheatsheet
branch
from
July 16, 2026 12:57
60fce19 to
00680ea
Compare
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
2 participants
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.
What does this PR resolve? 🚀
Adds a Swarm Cheatsheet to the docs, served from our own domain and kept in sync with the
swarm-cheatsheetsrepo so the content is never maintained in two places.<iframe>; the page + its assets are mirrored fromswarm-cheatsheets@mainintostatic/at build time.swarm-cheatsheetsstays the single source of truth — a fresh copy is fetched on every build, nothing is copied by hand.Details 📝
scripts/fetch-cheatsheets.mjs, run fromprebuild): fetches the cheatsheet HTML, its assets (fonts, QR lib, logos), and the PDF, rewriting../../../assets/→../assets/and../../../dist/→../(matching the source repo's ownsite.sh). Output lands instatic/cheatsheets/and is served at/cheatsheets/overview/.static/cheatsheets/is gitignored (rebuilt each build, never committed), matching the existingawesome-swarm/openapi.yamlpattern.static/llms.txtsends agents to the self-hosted page.Checklist ✅
masterand resolved conflictsnpm run buildsucceedsnpm run check:links) where relevantstatic/llms.txtupdated if pages were added / renamed / deletedSwarmvsswarm, ..)git commit -s)