docs(architecture): scaffold animated Protocol Reference section#2949
Open
chefsale wants to merge 44 commits into
Open
docs(architecture): scaffold animated Protocol Reference section#2949chefsale wants to merge 44 commits into
chefsale wants to merge 44 commits into
Conversation
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.
What
Starts a new Protocol Reference under
architecture/protocol/— an implementation-level guide aimed at someone building an independent Calimero node from scratch. It's organised around the life of one operation (birth → convergence) rather than crate by crate.This is a walking skeleton / template-setter, not the full reference. It establishes the structure, voice, and diagram style so the remaining chapters can be filled in consistently.
Contents
protocol/index.html— section landing page: the one core idea, an animated life-of-an-operation sequence diagram, the four writing principles, and the 10-chapter TOC withdraft/plannedstatus chips.protocol/concepts.html— Chapter 1 (Concepts & Scopes): defines the scope abstraction (the replication/encryption/membership/convergence domain) with an animated scope-tree diagram.seq-diagram.js+styles.css— the step-cascade animated-SVG engine, extracted out ofsequence-diagrams.htmlinto shared assets so every page reuses it. Data-driven sequence diagrams + aprefers-reduced-motionfallback.nav.js— registers the new section and tidies two auto-generated PR-title nav labels into clean names.How to preview
master(pages.yml), so this PR has no auto preview URL. To view locally:Notes / follow-ups
master, we should fencearchitecture/protocol/**out of the doc auto-update bot so hand-authored pages aren't clobbered.🤖 Generated with Claude Code