search

JSMonk / hegel

An advanced static type checker
https://hegel.js.org
MIT License
2.09k stars 59 forks source link

Describe top level architecture #261

Closed artalar closed 4 years ago

artalar commented 4 years ago

It would be grate to describe a top level architecture of the Hegel and it infra: (something like that, just from my thoughts)

It important for fast start to new contributors.

Make it as a diagram in draw.io or excalidraw.com and link core features to dirs / files in the repo would be awesome.

thecotne commented 4 years ago

i think we need to setup video calls instead of youtube streams so that contributors can ask questions and we can more easily contribute to the project

it is hard to ask questions on stream because of delay (for me it's like 20 seconds before my text appears on the stream) and because i am texting and other person is speaking

for example: @JSMonk can explain project architecture in video call we can ask questions and after that we can contribute diagrams and docs etc.

Raynos commented 4 years ago

A good approach for documenting is to open a PR with incomplete docs and have them be cleaned up and "corrected".