High-level diagram representation of the mixpanel-python codebase #134
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 am introducing abstract diagram mapping of the mixpanel-python codebase.
You can see how these files render in github's ui here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/mixpanel-python/on_boarding.md
Me and a friend are building these diagram generation via Static Analysis and LLMs. We believe that diagram driven documentaiton is best for new people to get up-to-speed with an existing codebase. This said we know maintaince of such docs can be tedious so atm we are working on Github action which can do it. I would love to hear your opinion on diagram driven documentation and especially in the case of on-boarding!
Any feedback 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.