Visualization for the medconb codebase #20
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
Author
|
Just a quick update, CodeBoarding is open-source now: https://github.com/CodeBoarding/CodeBoarding |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 high-level diagram visualization for the codebase in medconb. Me and a friend are working on helping the process of getting to know a new codebase. We believe visuals are the best way to do it so we are generating diagrams based on Static analysis and LLMs.
You can see how the diagrams int his PR will look like in the github ui here (after they are merged): https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/medconb/on_boarding.md
This maps only the python code for now, however we are working on support for TS as well so you can get the full picutre.
I would love to hear how you go about on-boarding new people to existing codebases in Bayer-Group and if you think what we do can be useful and used in this process.
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.