Visualization of the opencv-python codebase #1103
Open
+702
−0
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 have generated high-level diagram to help new developers to get to know the opencv-python project (from the stand point of contributors).
Me and a friend of mine are on a quest to help people get to know codebases faster. Thus we think visualization is very important and decided to generate high-level diagrams as we think this is the fastest and easiest way to get you started on a new codebase. To see how the docs render in markdown you can check them here - https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/opencv-python/on_boarding.md
The generation is based on static analysis and on top of that LLMs, and so far we are supporting python.
We would love to hear your opinion of the generated diagrams further we are interested in your current process of onboarding new developers and if we can be useful by any means.
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.