Description
Enhance the developer documentation by adding sequence diagrams that illustrate how notifications flow between clients, backend services, smart contracts, and subscribers. This will make the project easier to understand for new contributors.
Tasks
Add Mermaid sequence diagrams.
Document notification request flow.
Illustrate event processing lifecycle.
Link diagrams from README.md and ARCHITECTURE.md.
Verify diagrams render correctly on GitHub.
Acceptance Criteria
Sequence diagrams accurately represent the system.
Documentation is easy to follow.
All diagrams render correctly.
Cross-links between documentation files are valid.
Contributors start work by running:
git checkout -b docs/api-sequence-diagrams
Description
Enhance the developer documentation by adding sequence diagrams that illustrate how notifications flow between clients, backend services, smart contracts, and subscribers. This will make the project easier to understand for new contributors.
Tasks
Add Mermaid sequence diagrams.
Document notification request flow.
Illustrate event processing lifecycle.
Link diagrams from README.md and ARCHITECTURE.md.
Verify diagrams render correctly on GitHub.
Acceptance Criteria
Sequence diagrams accurately represent the system.
Documentation is easy to follow.
All diagrams render correctly.
Cross-links between documentation files are valid.
Contributors start work by running:
git checkout -b docs/api-sequence-diagrams