Skip to content
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.

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

Document application architecture #228

Closed
emkll opened this issue Jan 15, 2019 · 3 comments
Closed

Document application architecture #228

emkll opened this issue Jan 15, 2019 · 3 comments
Assignees
Labels

Comments

@emkll
Copy link
Contributor

emkll commented Jan 15, 2019

As the application complexity increases, it might be useful to document (for example using a diagram) the high-level application architecture to better understand the different major components at a glance and how they interact with each other.

This will help both developers and newcomers, especially those not familiar with Qt and Qt-specific patterns.

@emkll emkll added the docs label Jan 15, 2019
@eloquence
Copy link
Member

@redshiftzero and @creviera have been working on a GDoc with some initial notes; for the 7/24-8/7 document, we've committed to aim to clean up this document to a degree that it can readily be turned into a first docs PR. This will not include any architectural diagrams, just yet.

@sssoleileraaa sssoleileraaa self-assigned this Aug 12, 2019
@sssoleileraaa
Copy link
Contributor

This is where we're keeping the WIP-architecture docs: https://github.com/freedomofpress/securedrop-client/wiki/Architecture, which right now is very minimal and hopefully will steadily grow and become more detailed as we devote a bit of time to them each week and build out the client.

@kushaldas
Copy link
Contributor

I am approving the current document. We have to remember to keep updating it for any architectural change. @creviera Thank you for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants