Skip to content

Diagrams for the neusomatic codebase#88

Open
ivanmilevtues wants to merge 1 commit intobioinform:masterfrom
CodeBoarding:master
Open

Diagrams for the neusomatic codebase#88
ivanmilevtues wants to merge 1 commit intobioinform:masterfrom
CodeBoarding:master

Conversation

@ivanmilevtues
Copy link
Copy Markdown

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

These diagrams are designed to help people quickly understand a codebase. At Roche, where many scientists collaborate, it's common to dive into others' experiments and code. Our goal is to reduce the time it takes to get up to speed—from hours to just minutes—by using visual aids instead of reading through the entire code. I'd love to hear about your onboarding process for new codebases and whether resources like this would be helpful.

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.

@ivanmilevtues
Copy link
Copy Markdown
Author

Hey all, a quick update, our diagram generation engine is now fully open-source: https://github.com/CodeBoarding/CodeBoarding

If you are interested to see how exactly the generation was made 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