Skip to content

docs: add mermaid architecture diagrams - #108

Merged
0xfandom merged 1 commit into
mainfrom
docs/architecture-diagrams
May 5, 2026
Merged

docs: add mermaid architecture diagrams#108
0xfandom merged 1 commit into
mainfrom
docs/architecture-diagrams

Conversation

@0xfandom

Copy link
Copy Markdown
Collaborator

Summary

  • README: system topology, hot-path sequence, risk state machine (replaces existing ASCII + numbered list, net +1 diagram)
  • docs-site: new / cleaned-up diagrams across overview, rust-core, grpc-protocol, design-decisions, smart-contract
  • All rendered + validated via vitepress build (mermaid plugin, dark theme)

Files Changed

File Change
README.md ASCII → mermaid system topology; numbered list → hot-path sequence; added risk state machine
docs-site/architecture/overview.md simplified end-to-end sequence (4 lanes)
docs-site/architecture/rust-core.md crate dependency graph, hot-path flowchart, SPFA detection flowchart
docs-site/architecture/grpc-protocol.md SubmitArb + StreamArbs sequences; SystemState transitions
docs-site/architecture/design-decisions.md MVCC snapshot swap sequence; flash-loan atomicity sequence
docs-site/architecture/smart-contract.md contract flow simplified from 6 lanes to 4 + loop

Acceptance Criteria

  • npm run build in docs-site passes with no mermaid errors
  • All diagrams render correctly on GitHub blob view
  • README retains same length (two replacements + one small addition)
  • No behavior changes outside documentation

Test plan

  • Ran cd docs-site && npm run buildbuild complete in 10.64s, no errors
  • Dev server (npm run dev) — all 4 architecture pages load, diagrams render in dark theme
  • Pushed branch, verified GitHub blob-view rendering of all README + docs-site diagrams
  • Cross-checked wide-diagram fixes: overview end-to-end, rust-core hot-path, smart-contract flow, design-decisions flash-loan — all render without horizontal overflow

README: system topology, hot-path sequence, risk state machine.
docs-site: end-to-end sequence, crate dep graph, SPFA flowchart,
SubmitArb/StreamArbs sequences, SystemState transitions, MVCC
snapshot swap, flash-loan atomicity, contract flow cleanup.
@vercel

vercel Bot commented Apr 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
aether Ready Ready Preview, Comment Apr 23, 2026 7:53am
aether-63xv Ready Ready Preview, Comment Apr 23, 2026 7:53am

@0xfandom
0xfandom requested a review from Pablosinyores April 23, 2026 07:53
@0xfandom
0xfandom merged commit 34ed95b into main May 5, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant