High-level diagram representation of the mixpanel-python codebase
In this PR, I am introducing abstract diagram mapping of the mixpanel-python codebase. You can see how these files render in github's ui here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mixpanel-python/on_boarding.md
Me and a friend are building these diagram generation via Static Analysis and LLMs. We believe that diagram driven documentaiton is best for new people to get up-to-speed with an existing codebase. This said we know maintaince of such docs can be tedious so atm we are working on Github action which can do it. I would love to hear your opinion on diagram driven documentation and especially in the case of on-boarding!
Any feedback is more than welcome!
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: https://github.com/CodeBoarding/CodeBoarding is now an open-source project so you can see exaclty how we generate the diagrams!