search

uwasystemhealth / IndEAAv2

A web application that streamlines course review by industry advisory panels. A complete rewrite of https://github.com/uwasystemhealth/IndEAA
4 stars 1 forks source link

Add Readme #92

Open SRADHA-SURESH12 opened 1 year ago

SRADHA-SURESH12 commented 1 year ago

What needs to be done?

There is a need for a structured readme file in order to understand the project.

frinzekt commented 1 year ago

Hi @SRADHA-SURESH12, thank you very much for raising this issue!

The current documentation of the project can be seen in https://indeaav2-docs.systemhealthlab.com/developer/

that first page of documentation corresponds to this https://github.com/uwasystemhealth/IndEAAv2/blob/develop/docs/docs/developer/index.md in the repository structure.

If you want to know more about the project in terms of its context, here's the requirements document of the project. Proposal___IndEAA_MPE.pdf

The gist of it:

  1. We are streamlining the course accreditation review process in UWA
  2. This repo is a complete rewrite of https://github.com/uwasystemhealth/IndEAA. The rewrite allows us to scale this to accomodate for other universities or institutions that undergoes a similar format of accreditation review process
frinzekt commented 1 year ago

Hi @uwasystemhealth/redbacks, can anyone of you review our documentation and add the main documentation link in the readme.md file?

Having a quick look, we have some stuff missing:

Happy to divide it into more github issues