BioPhi icon indicating copy to clipboard operation
BioPhi copied to clipboard

Visualization for the BioPhi codebase

Open ivanmilevtues opened this issue 7 months ago • 1 comments

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.

ivanmilevtues avatar Jun 08 '25 21:06 ivanmilevtues

A quick update, CodeBoarding is open-source now: https://github.com/CodeBoarding/CodeBoarding

ivanmilevtues avatar Aug 01 '25 07:08 ivanmilevtues