Skip to content

docs: add hand-drawn architecture diagram to README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Araon merged 1 commit into from
Sep 5, 2026
Merged

docs: add hand-drawn architecture diagram to README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 3 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,9 @@ A warm auction does not call Redis or a DSP. The server ranks bids by priority,

## Design

```mermaid
flowchart LR
Admin["Admin client"] -->|"versioned bid change"| Redis[(Redis)]
Redis -->|"invalidation"| Cache["Local bid snapshot"]
Redis -.->|"reconciliation"| Cache

Client["Auction client"] -->|"POST /v1/auction"| Server["Go server"]
Cache -->|"local read"| Server
DSP["DSP endpoints"] -.->|"background refresh"| Dynamic["Local DSP cache"]
Dynamic -->|"fresh bids"| Server
Server --> Decision["winner or no_bid"]
```
![Adserver architecture showing the local auction path, Redis bid distribution, background DSP refreshes, and monitoring](docs/architecture.svg)

[Editable Excalidraw diagram](docs/architecture.excalidraw)

Redis is the source of truth for active bids. Pub/Sub invalidations tell each server to refresh a placement.

Expand Down
Loading