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.

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

Documentation #122

Open
sbaumohl opened this issue Apr 7, 2020 · 0 comments
Open

Documentation #122

sbaumohl opened this issue Apr 7, 2020 · 0 comments
Assignees
@sbaumohl
Labels
effort: hard enhancement help wanted priority: medium work length: long

Comments

@sbaumohl
Copy link
Member

sbaumohl commented Apr 7, 2020 •
edited
Loading

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sbaumohl sbaumohl

Labels
effort: hard enhancement help wanted priority: medium work length: long
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sbaumohl