Skip to content

High-Level Diagrams of SomaticSeq's codebase #144

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

This PR adds onboarding documents with Mermaid diagrams that provide a high-level overview of the SomaticSeq codebase. You can see an example of how these diagrams render in another project here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/somaticseq/on_boarding.md

The goal is to help new contributors—especially those who use code as a tool rather than working as full-time software engineers—quickly understand the structure and flow of the code. Given that BioInform is part of Roche, we imagine there are many scientists who interact with code, and we’d love to know if diagrams like these could support their workflows.

We’re curious if this would be helpful for your team, what your current onboarding process looks like, and whether automated diagrams like this could play a role in it.

We generate them using static analysis and LLMs, and we’re building a GitHub Action to keep them updated automatically (e.g., on each merge to main or release).

Full disclosure: We’re in the early stages of building a startup around this, and trying to understand what’s genuinely useful to research and open-source communities.

Thanks so much for taking a look—any feedback would be hugely appreciated!

@ivanmilevtues ivanmilevtues changed the title Added high-level diagrams High-Level Diagrams of SomaticSeq's codebase Jun 29, 2025
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