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

Improved documentation #109

Open
sgdavis1 opened this issue Jul 16, 2021 · 0 comments
Open

Improved documentation #109

sgdavis1 opened this issue Jul 16, 2021 · 0 comments
Assignees
Labels
documentation Documentation needs to be updated

Comments

@sgdavis1
Copy link
Member

sgdavis1 commented Jul 16, 2021

We need to improve the system architecture and data modeling documentation.

Currently the Sequelize models are relatively easy to find and parse, because the code is well organized and centralized by nature. However, I would like a little more detailed description of several components of this project:

  1. The total system architecture (probably using Whimsical.com)
  2. The data models retained in memory by the large system.js construct

Until we introduce Typescript ( #92 ), it will be very important to have these items better described and up-to-date to ensure consistency across the system. It will also hopefully help us identify places to improve code architecture and modularity if we have a high-level document and diagram of the current system available for discussions.

@dominicrutk dominicrutk added the documentation Documentation needs to be updated label Jul 23, 2021
@sgdavis1 sgdavis1 assigned sgdavis1, ashleyseo and Jacks-01 and unassigned sgdavis1 Aug 9, 2022
@sgdavis1 sgdavis1 pinned this issue Aug 16, 2022
@sgdavis1 sgdavis1 added this to the Sync up `devel` and `master` milestone Aug 16, 2022
@sgdavis1 sgdavis1 unpinned this issue Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation needs to be updated
Projects
None yet
Development

No branches or pull requests

4 participants