docs: add architecture overview and participant architecture#475
Open
cgdusek wants to merge 1 commit intodigital-asset:mainfrom
Open
docs: add architecture overview and participant architecture#475cgdusek wants to merge 1 commit intodigital-asset:mainfrom
cgdusek wants to merge 1 commit intodigital-asset:mainfrom
Conversation
…rchitecture Add a Mermaid diagram to README.md showing how participant nodes, sequencers, and mediators interact within a synchronizer. Fill in the previously empty participant-architecture.rst with component descriptions, command processing flow, and cross-references. Closes digital-asset#390
|
✅ All required contributors have signed the CLA for this PR. Thank you! |
Author
|
I have hereby read the Digital Asset CLA and agree to its terms |
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
README.mdwith a Mermaid diagram showing how participant nodes, sequencers, and mediators interact within a synchronizerparticipant-architecture.rstindocs-open/with component descriptions, command processing flow, multi-synchronizer and HA cross-referencesCloses #390
Context
PR #391 previously attempted to address this issue but was closed because:
docs/architecture/instead ofdocs-open/Per @soren-da's guidance, docs now live in
docs-open/and contributions are welcome there.Changes
README.md— New Architecture section with:protocol.rst(Alice multi-hosted on P1/P3, Bob on P1, Charlie on P2, two sequencers, one mediator)participant-architecture.rst— Replaced empty WIP stub with:Architectural accuracy
All content verified against
protocol.rst,participant.rst,synchronizers.rst, and the maintainer review comments on #391:protocol.rstTest plan
synchronizer-architecture,protocol-sequencer-nodes,reassignment-protocol,multiple-synchronizers,participant-ha)