Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/trident_architecture_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Trident Architecture Overview

High-level architectural overview of Trident contract framework components.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Loading