Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Visualization for the analytics-python codebase #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant