Diagram visualization of teh EasyOCR Codebase

[ivanmilevtues]

Hey all,
I've generated a diagram first documentation of the EasyOCR codebase, you can check it here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/EasyOCR/on_boarding.md

The diagram is designed to give a quick overview of the full structure of the codebase. As you have more than 3K forks, there are a lot of people who play around with your codebase as contributors, we believe that most of them are interested in certain components. With the diagram they can immediately understand and navigate to the component of interested, and when editing, now they have the context of how the component interacts with the rest of the system, which we believe is crucial.

I would love to hear what is your opinion on diagram first documentation!

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, wanted to update you all, that we just open-sourced our generaiton engine, so if you are interested in understanding how exactly the whole thing works you can do so here: https://github.com/CodeBoarding/CodeBoarding