Visualization of the OCRmyPDF codebase

[ivanmilevtues]

Hey all,
I noticed your discussion over EasyOCR JaidedAI/EasyOCR#1094. I have generated a high-level diagram first documentation for the OCRmyPDF codebase, you can check it here:

https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/OCRmyPDF/on_boarding.md

These diagrams are designed to give overview of the project, so whenever someone wants to contribute in interesting to them component they can do so easily. Starting from the highest level of abstraction they can see in which component they are interested and then click on it and find the relevant source code files and see how it interacts with the components around it. We believe the above are the best first steps into new codebase. I'd love to hear what is your opinion on the matter!

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 all, happy to announce that our generation engine is now open-source so you can head over there if you are interested to understand how the generation works in more detail: https://github.com/CodeBoarding/CodeBoarding