[Docs] Diagram visualization for teh equifold codebase

[ivanmilevtues]

I have generated high-level diagrams for the equifold project. The idea is to help people get up-to-speed with the codebase you can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/equifold/on_boarding.md

These diagrams are designed to help people grasp the codebase. The diagrams start from high-level of abstraction giving overview of what the main components of the project are and how they interact with each other. With this context a new person can drill down into a component of interest. Now they can extend/modify a small part of the codebase having the full context. We consider this especially valuable for scientists as in many cases reading code is not their priority, but rather quick modification to build on top of the existing method or evaluate it.

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.

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.

[ivanmilevtues]

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