classroom icon indicating copy to clipboard operation
classroom copied to clipboard

Documentation improvement: Add tech stack diagram and learning resources to the README

Open utsab opened this issue 2 years ago • 4 comments

We would like to add additional support materials to help new contributors become more familiar with the codebase:

  1. A description (ideally with a visual diagram) of the key technologies in the project's technology stack
  2. A recommended sequence of learning resources someone can work through to get some experience with the tech stack.

All of the information you need to answer the above two question is contained in this slide deck. For the tech stack diagram, look at slide 29. For the learning resources, take a look at slides 36 - 51.

For a model example of how an open source project can clearly document its technology stack, take a look at Open Energy Dashboard (see the "Built with" section). Then take a look at their more detailed helper page which lists out specific learning resources.

utsab avatar Feb 02 '23 22:02 utsab

Assigning this issue to Diego Vega, Jason Chan, and Siyuan Zhai.

utsab avatar Feb 02 '23 23:02 utsab

Hey @utsab the slide deck is private, could you take a look? Thanks

adriangzz avatar Feb 03 '23 23:02 adriangzz

Hii, @utsab I would like to contribute to this issue can you please assign it to me?

akashthedeveloper avatar Apr 05 '23 16:04 akashthedeveloper

Hey @utsab I can work on this if you would still like additional resources added to the read me file. There is a diagram added now but we are missing resources the tech stack like learning javascript for example. This issue is dated so I understand if this is not needed anymore.

Komal914 avatar Aug 03 '23 20:08 Komal914