Visualization of the chatterbox codebase
This PR includes high-level diagrams that represent the codebase of the catterbox repository. You can see how they render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/chatterbox/on_boarding.md
Me and a friend are trying to help people to get up-to-speed with new codebases. We believe that visualization is the best way to go that is why we are building high-level diagrams. We do so via static analysis and LLMs. I would love to hear your opinion on the generated diagram and diagram first documentation in general!
The idea is that these diagrams can be generated often and so they will be always up-to-date. (Currently looking into creating github action).
Usually I would open a discussion, but they are not enabled for this repository so I decided to open a PR instead.
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, wanted to do a quick update, we are now an open-source project: https://github.com/CodeBoarding/CodeBoarding