Skip to content

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
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

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

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