Documentation
sbaumohl opened this issue · 0 comments
sbaumohl commented
We should create Markdown docs to explain the intricacies of the MyMICDS website that would improve the learning curve for new developers.
This would be a massive undertaking, but would greatly enhance future developers understand how MyMICDS functions. The Documentation would include the frontend, backend, and SDK.
Examples of Documentation would include:
- Setting up your Dev Env, Linters, Configs
- What/Why is Typescript?
- Github Issues/PRs/Branches/Commits
- What function do different Angular Packages provide?
- How to create new modules/pages?
- Updating the SDK
- Dealing with Sentry