Repository navigation
docs: add animated explainer SVGs to the README and architecture doc - #24
Merged
Merged
Conversation
Add a product demo (docs/assets/demo.svg) under the README intro and a self-drawing architecture diagram (docs/assets/how-it-works.svg) at the top of ARCHITECTURE.md section 2. Both are pure-CSS animated SVGs with subset fonts embedded as data URIs and no scripts, so they autoplay and loop inside a README <img>. Viewers with reduced motion get a paused representative frame. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Christian Catalan <crcatala@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Christian Catalan <crcatala@gmail.com>
- Keep the OFL license URL (name ID 14) in each embedded font subset; the subsetter dropped it before. Copyright notices were already kept. - Add a comment to both SVGs crediting the embedded fonts under the SIL Open Font License 1.1. - The demo's agent now runs `curl -sI https://fl.example.com/...`. Without a scheme curl uses plain http, which can never answer the `HTTP/2 200` the animation shows. `-I` stays: the Worker serves HEAD. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Christian Catalan <crcatala@gmail.com>
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.
Summary
docs/assets/demo.svg) under the one-line description. It showsfl upprinting a short link, an agent on another machine fetching it withcurl -sI https://…(200), the link expiring (410 Gone) andfl refreshre-opening the same URL. Styling matches the landing page: near-black, volt yellow, Inter Black and JetBrains Mono.docs/assets/how-it-works.svg) at the top of section 2, above the existing ASCII diagram. It shows your machine, your Cloudflare account (Worker, private R2, Registry) and the agent, and walks through upload, fetch, expiry and refresh.Technical details
@keyframesonly. There is no JavaScript, because GitHub renders README images through<img>, which runs CSS animation but never scripts. Both loop on their own.<img>SVG can't load external fonts, so the text renders the same everywhere without depending on system fonts. Sizes are 73 KB (demo) and 84 KB (diagram).<h1>(align="top"). I checked this with GitHub's markdown API and its README stylesheet.prefers-reduced-motion: reduce, every animation is paused at a representative moment using a negativeanimation-delay. The demo shows the live link being fetched; the diagram shows the full picture with GET 200. Without this, those viewers would get the nearly blank first frame.alttext, and each SVG has a<title>/aria-label.Testing
<img>SVGs require.prettier --check README.md docs/ARCHITECTURE.mdpasses.🤖 Generated with Claude Code