Skip to content

[Docs] Author a system architecture overview with diagrams connecting contracts, backend, indexer, and frontend #1

@grantfox-oss

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

The repo has scattered design docs (DESIGN.md, LANDING_PAGE_DESIGN.md) and three wiki pages, but no single architecture overview that shows how the Soroban contracts, the backend API, the event indexer, the Postgres database, and the Next.js frontend fit together. New contributors cannot form a mental model of the system.

Acceptance criteria

  • Add architecture.md with a high-level component diagram (mermaid) of contracts, backend, indexer, DB, and frontend
  • Describe the request and event data flows (user action -> backend -> contract -> indexer -> DB -> frontend)
  • Link out to the contract reference, API reference, and indexer-sync-flow wiki pages
  • List the trust boundaries and the major external dependencies (Stellar RPC, Redis, Sentry)

Files to touch

  • architecture.md (new)
  • wiki/README.md
  • wiki/indexer-sync-flow.md

Out of scope

  • Per-service deep dives (separate issues)
  • Sequence diagrams for every endpoint

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationhardAdvanced / high-difficulty issuehelp wantedExtra attention is needed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions