Visualization for the bandit codebase

[ivanmilevtues]

Hey all,

I hope we get a nice discussion around visualization for codebases and the whole getting-to-know process :).

I am Ivan and with a friend we are trying to build something which can help people to get up to speed on new codebases. This should hopefully also help the main maintaners by freeing some time for them. We believe that at the very begining high-level understanding of the main components (what they are) and how they interact is crucial, further we think that diagram driven documentation is best for learning. Would love to hear your opinion on the matter!

This said, we are generating high-level diagrams, which are generated with the help of static analysis and LLMs. We generated one for the bandit project - https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bandit/on_boarding.md

Any sort of feedback on the diagram 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.

[ivanmilevtues]

Hey, just to add on the thing, we are also Open-Source now: https://github.com/CodeBoarding/CodeBoarding
If someone is interested you can check how the generation works in greater detail there :)