Visualization for the analytics-python codebase #514
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.