freeCodeCamp / classroom

BSD 3-Clause "New" or "Revised" License
145 stars 119 forks source link

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

Open utsab opened 1 year ago

utsab commented 1 year ago

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 commented 1 year ago

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

adriangzz commented 1 year ago

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

akashthedeveloper commented 1 year ago

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

Komal914 commented 11 months ago

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.