Skip to content

Visualization of the enact-pipeline codebase#56

Open
ivanmilevtues wants to merge 1 commit into
Sanofi-Public:mainfrom
CodeBoarding:main
Open

Visualization of the enact-pipeline codebase#56
ivanmilevtues wants to merge 1 commit into
Sanofi-Public:mainfrom
CodeBoarding:main

Conversation

@ivanmilevtues
Copy link
Copy Markdown

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

These diagrams help users quickly grasp the codebase. Many scientists work with the enact-pipeline, and our goal is to cut onboarding time from hours to minutes. Since most people focus on specific components, the diagram offers a high-level overview, letting them dive into what they are interested in with the needed context. I'd love to hear your thoughts—could this be part of your onboarding process?

Any feedback is more than welcome! We've just released a free GitHub Action that can automatically update the diagrams and this way keep them always up-to-date.

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 a quick update on our side, we are now open-source. If you are interested to see how exactly the diagrams are generated you can do so here: 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