Skip to content

Conversation

@ivanmilevtues
Copy link

This PR contains high-level diagrams for the alphafold codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/alphafold/on_boarding.md

These diagrams are designed to help people quickly understand a codebase. Probably a big portion of the people who engage with the alphafold repository are scientists which use code as tool, rather than full time job. Our goal is to reduce the time it takes them to get up to speed—from hours to just minutes—by using visuals instead of reading through the entire code. I'd love to hear if this sounds interesting to you, I know DeepMind is a serios research entity so I would love to hear where do you stand on diagram first documentation!

We’d love any feedback! We also just released a free GitHub Action that can automatically update the diagrams on merge to main (or based on other heuristics). Let me know what you think!

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.

@google-cla
Copy link

google-cla bot commented Jun 16, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@ivanmilevtues
Copy link
Author

Hey, just a quick update. CodeBoarding's diagram generation is now fully open-source: https://github.com/CodeBoarding/CodeBoarding!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant