docs: add Architecture Overview Guide (Closes #137)#150
Merged
Abd-Standard merged 1 commit intoJun 22, 2026
Merged
Conversation
Adds a single high-level architecture guide at the repo root that gives new contributors a unified mental model of NotifyChain before they dig into the per-component docs. Covers: - Three-layer system overview (on-chain contracts, listener, dashboard) - Contract catalog (TaskBounty + AutoShare) and event-emission pattern - Listener module map and scheduler subsystem with atomicity rationale - End-to-end data flow from contract invocation to dashboard render - Project structure map and a first-day contributor checklist - Links to every subsystem doc, runbook, and reference spec - Glossary of recurring terms (Soroban, cursor, dispatcher, DCO, GrantFox) Also wires the new guide into README.md: - Top-level Architecture Overview section now links to this file before the existing contract-level ARCHITECTURE.md - Project structure tree lists ARCHITECTURE_OVERVIEW.md at the root Refs: Core-Foundry#137 Signed-off-by: zeroknowledge0x Signed-off-by: zeroknowledge0x <zeroknowledge0x@users.noreply.github.com>
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
Adds a single high-level architecture guide at the repo root that gives
new contributors a unified mental model of NotifyChain before they dig
into the per-component docs.
Issue:
#137— Documentation > Create Architecture Overview Guide.What's in this guide
UPDATE ... WHERE status = 'PENDING'rationale482 lines, well under the size that would warrant splitting.
Acceptance criteria mapping
Files changed
ARCHITECTURE_OVERVIEW.md— new (482 lines)README.md— link from the existing Architecture Overview section + entry in the project structure treeTest plan
This is a documentation-only PR. No code changes.
h1→h2→h3)grep -oP '\]\([^)]+\)'returns 0 matches)Documents/Task Bounty/ARCHITECTURE.mdandlistener/ARCHITECTURE-DIAGRAM.mdto avoid contradictionsCloses #137
Signed-off-by: zeroknowledge0x