Skip to content

Conversation

@ivanmilevtues
Copy link

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!

@ivanmilevtues ivanmilevtues changed the title Added high-level diagrams [Docs] Diagram representation of WUCSS's codebase Jul 4, 2025
@ivanmilevtues
Copy link
Author

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant