docs: add API & notification sequence diagrams (#354)#423
Open
Dami24-hub wants to merge 1 commit into
Open
Conversation
- Add API_SEQUENCE_DIAGRAMS.md with five Mermaid sequence diagrams: 1. Notification Request Flow (webhook verify + scheduled delivery) 2. Event Processing Lifecycle (on-chain event → dedup → Discord) 3. Scheduled Notification Delivery (POST /api/schedule → states) 4. Retry & Failure Recovery (in-memory vs DB-backed retry paths) 5. Dashboard Data Fetch (React polling /api/events, /health, /analytics) - All diagrams reference actual source files, function names, and HTTP endpoints as implemented in the codebase - Update ARCHITECTURE_OVERVIEW.md §9 with a navigation table linking to each diagram by anchor - Update README.md Architecture Overview block and Event Flow section with prominent cross-links to API_SEQUENCE_DIAGRAMS.md Closes Core-Foundry#354
|
@Dami24-hub Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
1 participant
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.
This pull request resolves issue #354 by enhancing the developer documentation with interactive Mermaid sequence diagrams. These diagrams map out the end-to-end data flow between Clients, Backend Services, Smart Contracts, and Subscribers to improve architecture visibility for new and existing contributors.
Related Issue
Closes #354
Summary of Changes
Notification Request Flow Diagram: Visualized client-initiated notification requests, backend validation, job queuing, smart contract interactions, and dispatch to subscribers.
Event Processing Lifecycle Diagram: Visualized on-chain event emissions, backend indexer detection, worker processing, and subscriber alert delivery.
Documentation Navigation: Embedded and cross-linked the sequence diagrams within README.md and ARCHITECTURE.md.
Rendering & Navigation Verification: Confirmed all Mermaid syntax renders properly on GitHub and verified all relative file links function correctly.
Checklist
[x] Work committed on branch docs/api-sequence-diagrams
[x] Mermaid sequence diagrams added for all required system flows
[x] Diagrams verified to render correctly on GitHub
[x] Relative links between README.md and ARCHITECTURE.md validated
[x] Explanatory documentation added alongside diagrams