Put the SWIM mesh at the top of the README as a terminal demo - #10
Merged
Conversation
The README's only images were two benchmark charts at line 205, well below where anyone scrolls, and the Pages demo covers the transport half only. The membership half had nothing a visitor could see without building the project. mesh_node runs on the in-process SimNet and a virtual clock, so the recording is the real implementation rather than an animation, and it is deterministic: 1020 ms to the first SUSPECT, 2020 ms to reconverge after the heal, and the partitioned node never falsely confirmed dead. The two demos now split cleanly, the browser one for the transport and this one for membership. Those numbers are the same on macOS and Linux as of the SimNet determinism fix, which is what makes narrating them in the recording safe. I verified the default seed is a hardcoded constant rather than anything time-derived before committing to that claim. A VHS tape, so it re-records when the demo changes: ./docs/demo-setup.sh && vhs docs/demo.tape
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
1 participant
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.
The README's only images were two benchmark charts at line 205, well below where anyone scrolls. The Pages demo covers the transport half only, so the membership half had nothing a visitor could see without building the project.
mesh_noderuns on the in-process SimNet and a virtual clock, so this is the real implementation rather than an animation: five nodes gossiping, one partitioned away, 1020 ms to the first SUSPECT, 2020 ms to reconverge after the heal, and the reachable node never falsely confirmed dead.The two demos now split cleanly. Browser demo for the transport, this recording for membership.
Why narrating the numbers is safe here
They are identical on macOS and Linux as of the SimNet determinism fix in #9, which is the payoff for that change: before it, the same seed drew different sequences per standard library and these numbers would have been platform-specific.
I also checked the default seed is a hardcoded constant (
20260720ullindemo/mesh_node.cc:94) rather than anything time-derived, before committing to "reproducible". Worth noting a small pre-existing wart found while checking:mesh_node --helpdoes not print help, becausestrtoull("--help")returns 0 and it runs with seed 0 instead. Left alone, out of scope here.Reproducible, not a screen capture: