search

TryQuiet / quiet

A private, p2p alternative to Slack and Discord built on Tor & IPFS
https://www.tryquiet.org
GNU General Public License v3.0
1.96k stars 85 forks source link

Introduction of C4 diagrams to explain architecture to new contributors #1777

Closed Kacper-RF closed 1 year ago

Kacper-RF commented 1 year ago

I think that as part of a better onboarding of external collaborators, it is worth creating C4 diagrams of the Quiet ecosystem, thanks to which they will have a chance to see how different layers of the application work, what they are responsible for and communicate with each other.

As first step I will include two first levels of C4:

1.System context level - overall scope of the application and how it interacts with users. Recommended for people who just want to understand how Quiet works. 2.Container level - more detailed diagram with detailed application layer such as mobile apps, backend, state manager etc. Focuses on high-level technology, recommended for software developers who want to work as collaborators and become familiar with ecosystem.

https://c4model.com/

holmesworcester commented 1 year ago

Great, let's do it. Should we do it soon as part of our onboarding activities for @leblowl this week?

Kacper-RF commented 1 year ago

Yes, of course i can do it. But I'll start working on it tomorrow at the earliest or on Thursday, because now we are focused on trying to finish new registration flow(we are integrating all layers at the moment) which is worthy to be on diagrams in new form.

Kacper-RF commented 1 year ago

https://github.com/TryQuiet/quiet/pull/1819