analytics-python icon indicating copy to clipboard operation
analytics-python copied to clipboard

Visualization for the analytics-python codebase

Open ivanmilevtues opened this issue 7 months ago • 1 comments

In this PR I've added high-level diagrams to help new comers to get up-to-speed with the existing codebase.

You can see how they render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/analytics-python/on_boarding.md

Me and my friend are leveraging Static Anlaysis and LLMs to generate diagram driven documentation. We believe that when starting getting a high-level understanding is always crucial and after that one can dive deep into the component of interest. Would love to hear what is your on-boarding procedure and do you think that this diagram driven documentation can help?

Further we know that keeping docs up-to-date is noones favourite task, so atm we are creating a github action, so if interested you can generate such diagrams on demant.

Any feedback is more than welcome! I would usually start by opening discusssions, but in this case it seems they are not enabled so I opened 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.

ivanmilevtues avatar Jun 09 '25 12:06 ivanmilevtues

A quick update, we are an open-source project now: https://github.com/CodeBoarding/CodeBoarding So you can check exactly how we are generating these diagrams!

ivanmilevtues avatar Aug 01 '25 07:08 ivanmilevtues