docs: improve README project architecture section (#45) - #61
Merged
Abd-Standard merged 2 commits intoJun 19, 2026
Merged
Conversation
Collaborator
|
please fix CI |
- Add a three-layer architecture overview (contracts, listener, dashboard) with a component responsibility table - Add a component-interaction diagram and reference the detailed ARCHITECTURE.md write-up - Describe contract responsibilities and the end-to-end notification flow - Document the listener and dashboard directories in project structure - Update features and tech stack to reflect the now-implemented off-chain listener service and Discord notifications
- Regenerate dashboard/package-lock.json; the committed lockfile was corrupted (invalid JSON), which broke the Frontend job at the Setup Node cache step and 'npm ci' - Add the '@testing-library/jest-dom' side-effect import to EventFiltersBar.test.tsx so 'toBeInTheDocument' is typed during the TypeScript build (tsc --noEmit) - Run cargo fmt on version_test.rs to satisfy the Rust 'fmt check' job Verified locally: dashboard lint/build/test pass and 'npm ci' succeeds; contract 'cargo fmt --all -- --check' is clean and all 86 tests pass.
Itodo-S
force-pushed
the
docs/improve-readme-architecture-45
branch
from
June 18, 2026 22:43
337391e to
7f80781
Compare
Contributor
Author
|
Thanks for the review! I've rebased onto the latest Frontend (lint, typecheck, test)
Rust (fmt check, tests)
Verified locally:
The new CI run is currently in |
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
Closes #45.
The README explained NotifyChain at a high level but did not describe how the smart contracts and off-chain services actually interact — and it still labelled the listener as a "future" component even though it is now implemented. This PR brings the architecture documentation in line with the current codebase.
Changes
Documents/Task Bounty/ARCHITECTURE.md.EventSubscriber,NotificationDeduplicator,DiscordNotificationService, events API).listener/anddashboard/directories.Acceptance criteria
Documentation-only change; no code paths affected.