[Docs] Diagram representation of WUCSS's codebase #2
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.
This PR includes diagram-based documentation which shows the main components of the codebase and how they interact with each other. You can see how they render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/WUCSS/on_boarding.md
These diagrams are designed to make codebases more approachable—especially for those who use code as a tool to support research or analysis, rather than as professional software engineers.
The WUCSS module is an exciting example of that. As part of the Neural Circuits Lab in NRD at Roche, we believe tools like these diagrams could help collaborators across neuroscience and data science ramp up faster, understand the workflow more easily, and contribute more confidently.
We’re generating these diagrams through a mix of static analysis and LLMs. We’ve also built a GitHub Action you can add to any repository—it automatically keeps the diagrams up to date on every merge to main, release, or based on custom heuristics.
We’d love to connect and learn more about your workflow and onboarding needs—especially around how we can support cross-functional collaboration between scientists, analysts, and engineers. If you're open to a short chat, we’d be excited to explore how this tooling could help teams like yours.
Thanks for your time!