Visualization of the PyHive codebase #484
Open
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
|
Happy to share that we are open-source now: https://github.com/CodeBoarding/CodeBoarding. If you are interested to check how the diagrams are generated in detail you can check there! |
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.
This PR contains a visualizaiton of its codebase.
The idea of these diagrams is that they will help people get up-to-speed with the codebase. You can see how they render in the GitHub UI here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PyHive/on_boarding.md
The diagram is generated via Static Analysis and LLMs. I would love to hear how do you go about on-boarding and maintaining documentation in Dropbox. 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.