Visualizatiion for the python-twitch-client codebase
This PR contains high-level diagrams for the python-twitch-client. You can see how the render in the github UI here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-twitch-client/on_boarding.md
Me and my friend leverage static analysis and LLMs to build such diagrams, we think that they are the best way for a new person to get up-to-speed with the codebase. Having such visuals gives you imidiate context on what are the main components and how they interact with each other! Further by generating them, they can easily be maintained as up-to-date, we are currently working on a github action to do that!
Any feedback is more than welcome!
I would usually open a discussion first, but they don't seem to be enabled for this project, so decided to go ahead and crear a PR!
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.
A quick update https://github.com/CodeBoarding/CodeBoarding is now open-source!