Skip to content

Conversation

@ivanmilevtues
Copy link

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

These diagrams are designed to help people quickly understand a codebase. At Illumina, many scientists collaborate, so I suppose it's common to dive into others' experiments and code. Our goal is to reduce the time it takes one person to get up to speed—from hours to just minutes—by using visuals (diagrams) instead of reading through the entire code. It would be awesome to hear if what we provide can be useful to your teams to be more productive and enhance collaboration as it eases the way one interacts with new codebase.

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.

@ivanmilevtues
Copy link
Author

Hey all, happy to notify you that CodeBoarding is now open-source: https://github.com/CodeBoarding/CodeBoarding
If you want to see how the diagrams are generated in detail, you can do so over there :)

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