docs: add system architecture document with C4 diagrams - #227
Merged
snowrugar-beep merged 5 commits intoJul 20, 2026
Merged
Conversation
Creates docs/ARCHITECTURE.md describing VertexChain's system architecture. Includes C4 Level 1 (System Context), Level 2 (Containers), and Level 3 (Backend Components and Soroban Smart Contracts) diagrams in Mermaid, as well as detailed sequence diagrams for the Gist Creation and On-Chain Event Indexing data flows.
Contributor
|
Heads-up: CI was green a moment ago but this PR is no longer marked MERGEABLE, so I didn't auto-merge it. Could you rebase against |
Contributor
|
Hey \xf0\x9f\x91\x8b \xe2\x80\x94 small update: my very first note on this PR suggested the mergeable status was a transient hiccup. After more careful checking, it turns out the branch now actually has merge conflicts against |
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.
Closes #191
Overview
This PR addresses the lack of high-level architectural documentation in the repository by introducing a comprehensive
docs/ARCHITECTURE.mdfile. It provides new contributors and developers with a clear overview of how the VertexChain components interface with each other and the underlying technologies (Next.js, NestJS, PostGIS, IPFS, and Stellar/Soroban).Changes Made
docs/ARCHITECTURE.mdcontaining:Verification