[Docs] Documentation representation for GearNet
In this change I have generated a diagram representation of the GearNet codebase. You can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/GearNet/on_boarding.md
A lot of scientists and researchers are looking at this codebase, and the goal of the diagrams is to help them get up-to-speed. I am sure that most of them are interested mostly in one/two components. The diagram show all the main components of the codebase and then one can focus on the component of interest - expand it and see how it works. With this context now you can see what the linked source files are and start reading those in details with the full context of the codebase.
Would love to connect and discuss how we can help further!
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date, I'd be more than happy to integrate it for you if you like it!
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.
Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding