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/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 /docs folder).

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!

@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