what-is-iroh: merge in "how iroh works" narrative with animated diagrams#74
Merged
Conversation
Brings the animated SVG walkthrough from iroh.computer PR #479 into the docs "What is iroh?" page: connect-by-key, guaranteed connections, library and relays, endpoint startup, peer lookup (DNS + DHT), and direct connections (hole punching + LAN). Adapts the blog's Next.js JSX to Mintlify's <Frame>/<img> convention, cross-links to existing concept/connecting pages, and renders each diagram on a white background so the SMIL/CSS animations stay readable in both light and dark themes. Keeps the existing layer-stack diagram, code example, and getting-started links. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Nice. I think the stack image now looks a bit out of place. We can replace it as well. Most of the animations don't work for me in the preview. Not sure what's going on. I think we should adapt the SVGs so they also work with a black background. The white background in dark mode looks a bit strong. img should work well, but I did object because some of the svgs do have tooltips which aren't visible for img. |
Contributor
|
Check out my latest changes. I think the colours now work better with black bg. |
Pulls rklaehn's regenerated animations (all 8 SVGs updated) and renames "Guaranteed connections" -> "Reliable connections" to match the source PR. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
rklaehn's SVGs are now theme-aware (transparent canvas + color-scheme: light dark + a neutral palette), the same way they render on iroh.computer. The white-background wrapper was forcing a glaring light slab in dark mode and defeating that design. Drop it and let each diagram render transparent inside Mintlify's theme-aware <Frame>; verified readable in both light and dark themes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Ok updated. Merging |
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.
Merges the animated SVG walkthrough from iroh.computer#479 into the docs What is iroh? page, with the PR's newer narrative and animations taking precedence over the old prose.
What's here
images/how-iroh-works/Adaptation notes
<object>,BlogPostLayout) to Mintlify's<Frame>+<img>convention<script>), so they play fine via<img>_darkvariants)Verification
Ran
mint devlocally — all 8 SVGs load, 0 console errors, links resolve, diagrams render correctly.🤖 Generated with Claude Code