# SyncYomi documentation

| Document | Read it when you… |
|---|---|
| [architecture.md](architecture.md) | want to understand how the server, web UI and the Tachiyomi clients fit together and how a sync round-trip works |
| [api.md](api.md) | are writing or debugging a client, or wiring the web UI to the server |
| [sync-protocol-v2.md](sync-protocol-v2.md) | implement or debug a client, or want to know exactly how the merge decides |
| [data-model.md](data-model.md) | are looking at the database tables |
| [clients.md](clients.md) | update TachiyomiSY, Komikku or Suwayomi-Server to protocol v2 |
| [operations.md](operations.md) | run a SyncYomi server: configuration, databases, upgrades, rolling back sync data |
| [development.md](development.md) | want to build, test or contribute |

The machine-readable API description lives in [`../OpenAPI.yaml`](../OpenAPI.yaml).