Skip to content

Conversation

ivanmilevtues
Copy link

This PR includes documentation enhanced with Mermaid diagrams that represent the codebase at a high level. You can view how they’re rendered here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/foxops-client-python/on_boarding.md

The goal of these documents is to help people get up to speed quickly with the foxops-client-python codebase. The diagrams are designed to make codebases more approachable—especially for those who use code as a tool rather than as professional software engineers.

We believe this can be especially helpful in organizations like Roche, where many scientists and domain experts write or interact with code to support their work. We'd love to hear if diagrams like these could improve your onboarding or collaboration processes. What does your current onboarding look like? Do you think auto-generated, diagram-first documentation could play a role?

We’re generating these diagrams using a combination of static analysis and LLMs. We’ve also built a GitHub Action that you can add to any repository—it automatically updates the diagrams on every merge to main, release, or based on other heuristics.

We’d really love to connect and learn more about your needs—whether it's around onboarding, documentation, or helping people work more effectively with code. If you’re open to a quick chat, we’d be excited to explore how we can support your team.

@ivanmilevtues ivanmilevtues requested a review from defreng as a code owner July 4, 2025 23:29
@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