docs: add Trident framework architecture overview - #348
Conversation
| @@ -0,0 +1,3 @@ | |||
| # Trident Architecture Overview | |||
|
|
|||
| High-level architectural overview of Trident contract framework components. | |||
There was a problem hiding this comment.
The PR is titled "add Trident framework architecture overview", but this is a three-line file whose entire body restates the title. An architecture overview needs to actually describe the architecture: the indexer -> Postgres -> Redis -> gRPC API -> Go REST API pipeline, where the crates in crates/ and services in services/ sit in it, and how events flow from Soroban RPC through to /v1/events and the WebSocket/SSE streams.
There is real material to draw on: README.md, docs/deployment.md, and docs/ENVIRONMENT.md already document parts of this, and crates/indexer/src/streamer/mod.rs is the core of the ingest path.
Also: please target dev rather than main (all feature work lands on dev), and drop the UTF-8 BOM at the start of the file — no other file in docs/ has one.
A genuine overview would be a welcome addition, so please do resubmit with actual content.
|
Hey @joan-bisbal — this is the best of the three docs PRs. The title is right, the mermaid diagram matches the actual service topology, and the component breakdown lines up with what's really in Two small things before I merge. The description is one line, and it's doing less than it could. A reader landing on this PR can't tell what's covered or why it exists. Something like:
Second, a naming nit: everything else in Both are quick. Once they're in I'll merge this one. |
|
Thanks for the review. Both changes done:
Ready for re-review. |
Adds a high-level architecture overview for new contributors: the ingest -> decode -> persist -> serve pipeline, what each service owns, and how PostgreSQL and Redis divide responsibility between durable history and real-time fan-out.
Includes a mermaid diagram of the full data path from Soroban RPC through to REST/gRPC/WebSocket clients.
No code changes -- documentation only.