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.

Sign up for GitHub

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

Jump to bottom

Add architecture and design documentation #631

Open

strinsberg opened this issue Aug 18, 2020 · 0 comments

Assignees

Labels

Collaborator

strinsberg commented Aug 18, 2020

TODO

Create a folder for a LaTeX document for design documentation
Put together High level documentation that covers the architecture, and layout of the project
Give current and new workers an idea of where they need to look for things and how and why the project is set up the way it is. For more specifics people can refer to the generated code documentation which will deal more with the API and finer details.

strinsberg added the documentation label

strinsberg self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment