matrix-org / matrix-rust-sdk

Matrix Client-Server SDK for Rust
Apache License 2.0
1.26k stars 252 forks source link

doc: start an architecture document with a high-level description of the crates #4198

Closed bnjbvr closed 1 week ago

bnjbvr commented 2 weeks ago

Based on reading the https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html blog post, @andybalaam and I started an architecture document explaining at a high-level what the different crates are. We hope to also include the most important high-level components in the mix, as a vague map of where things are implemented. (e.g. Timeline, SyncService, RoomListService, etc.). Very WIP-y, etc.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.93%. Comparing base (75683d2) to head (d690fc9). Report is 73 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4198 +/- ## ========================================== + Coverage 84.88% 84.93% +0.04% ========================================== Files 272 272 Lines 29131 29131 ========================================== + Hits 24729 24741 +12 + Misses 4402 4390 -12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.