Visualizing fmriprep's codebase #3477
ivanmilevtues
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hey I generated a diagram representaiton for the fmriprep's codebase via static analysis and LLMs: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fmriprep/on_boarding.md
I wanted to share an idea we're exploring: diagram-first documentation to help contributors quickly understand and navigate complex codebases. Since fmriprep is used by researchers and scientists in the neuroscience field, we believe visualizing the main components and their interactions can make it much easier for such people to jump into the parts that matter most for them. As usually scientists and researchers are more interested in the method and not the codebase itself.
We’ve also set up a GitHub Action to keep the diagrams automatically updated with code changes. Would love your feedback—and happy to help integrate this if there’s interest!
Full disclosure: we’re in the early stages of turning this into a startup.
Beta Was this translation helpful? Give feedback.
All reactions