Visualization for the BioPhi codebase #74
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.
This PR contains mermaid visualization of the BioPhi codeabse. You can see how the markdowns render in GitHub here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/BioPhi/on_boarding.md
Me and my friend are working on generating this diagrams using Static Analysis and LLMs. We do this diagram driven documentation as we believe this is the fastest for a person to get up-to-speed with an existing codebase.
I would love to hear what is your opinion on the diagrams generated for BioPhi, further it would be awesome to hear what is your current on-boarding process for introducing people to new codebases and if we can help in some shape or form to improve that!
Any feedback is more than welocme!
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.