High-Level Diagrams of SomaticSeq's codebase #144
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 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!