Skip to content

Diagram visualization of the MOCCA codebase#22

Open
ivanmilevtues wants to merge 1 commit intoBayer-Group:mainfrom
CodeBoarding:main
Open

Diagram visualization of the MOCCA codebase#22
ivanmilevtues wants to merge 1 commit intoBayer-Group:mainfrom
CodeBoarding:main

Conversation

@ivanmilevtues
Copy link
Copy Markdown

This PR contains high-level diagrams for the MOCCA's codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/MOCCA/on_boarding.md

The idea of these diagrams are to help people get up-to-speed with the codebase. I know that a lot of scientists interact with these codebases and I suppose they can make use of such diagrams and grasp the idea much faster than reading the code itself. I would love to hear what do you think about diagram first documentation for on-boarding and if it fits in your existing on-boarding processes.

We are also developing a github action which can generate the documentation for every commit in main. It will be available soon so let me know if that sounds interesting!

Any feedback is more than welcome!

Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.

I have opened also the PR's with diagrams for few of your other open source projects :)

@ivanmilevtues ivanmilevtues requested a review from m-lueb as a code owner June 10, 2025 14:49
@ivanmilevtues
Copy link
Copy Markdown
Author

Hey a quick update on our side, we are now an open-source repository: https://github.com/CodeBoarding/CodeBoarding
If interested how exactly the generation works, you can take a look there :)

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