[Docs] Visualization of the mole-public codebase. #7
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/mole_public/on_boarding.md
These diagrams are designed to make research codebases more approachable—especially for scientists and researchers who work with code to support analysis, rather than as professional software engineers.
We generate these diagrams using a mix of static analysis and LLMs. There’s also a GitHub Action you can add to your repository—it automatically keeps the diagrams up to date with every merge to main, release, or other branches you configure (also it can add the docs in to the
/docsfolder).We’d love to connect and learn more about your workflow—especially around onboarding, reproducibility, or cross-functional collaboration. If you’re open to a quick chat, we’d be excited to explore how we can help.
Thanks for your time!