Visualization for the Chemformer
This PR contains high-level diagrams for the Chemformer codebase. You can see how they render in Github here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/Chemformer/on_boarding.md
These diagrams are designed to help people quickly understand a codebase. At MolecularAI (AstraZeneca), where many scientists collaborate, our goal is to reduce the time it takes to get up to speed with someone elses codebase - from hours to just minutes - by using visuals instead of reading through the entire code. I'd love to hear how do you go about introducing people to codebases in MolecularAI.
We’d love any feedback! We also just released a free GitHub Action that can automatically update the diagrams.
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.
A quick update from our side, CodeBoarding is fully open-source now! If you are interested on exactly how we generate the diagrams you can head to our repo: https://github.com/CodeBoarding/CodeBoarding <3