-
Notifications
You must be signed in to change notification settings - Fork 536
Visualization of the nipype codebase #3729
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Open
+235
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a high-level architectural overview of the Nipype codebase using Mermaid diagrams. These diagrams aim to help new contributors—particularly those from neuroscience and research backgrounds—more easily understand the structure and flow of the code.
You can preview how these diagrams render in another project:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/nipype/on_boarding.md
We’re curious whether this could be helpful for your contributor community and how it might fit into your current onboarding process.
Note: We generate these diagrams using static analysis and LLMs. We're also developing a free GitHub Action that can keep them automatically updated on each merge to main or other branches.
This is part of an early-stage startup exploration focused on improving onboarding for open-source and research-focused projects.
Fixes # .
List of changes proposed in this PR (pull-request)
[x] Added Mermaid-based architectural diagram of the codebase