doc: start an architecture document with a high-level description of the crates #4198
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bnjbvr
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ 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 ☔ View full report in Codecov by Sentry. |
stefanceriu
approved these changes
Nov 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.