docs: animated architecture & package-explorer diagrams in README - #1
Merged
Conversation
|
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
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.
Adds two self-contained animated diagrams to the README so the architecture and the package-exploration flow are visible at a glance.
What
suiCLI (holding the keystore) and reads the Sui network over gRPC / GraphQL / faucet. Request dots trace a browser call and an agent call.How it renders
GitHub can't run a live HTML file inside a README, so each diagram is embedded as a GIF via
<picture>— a dark GIF is served to dark-mode readers and a light GIF to light-mode readers. Each has a link to the interactive HTML (light/dark toggle + pause) beside it.Files
docs/diagrams/*.html— the source diagrams, self-contained, open in any browserdocs/diagrams/*-{light,dark}.gif— README-embeddable recordings (~0.5 MB each), captured headless from the HTMLNo application code is touched — README + diagram assets only.