[Docs] Diagram visualization of the rexmex project

[ivanmilevtues]

Summary

In this PR I am introducing diagram first documentaiton. You can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/rexmex/on_boarding.md

The diagrams are designed so that people can quickly grasp the main flow of the project by seeing the main abstract components and how they interact with each other. There are a lot of scientists/researchers who interact with this codebase so I believe they are usually mostly interested in some particular part of the codebase. With these diagrams they can quickly navigate to that component and start editing it with the full context of the pipeline. Further most scientists are interested in the method and not as much in the codebase itself.

Would love to connect and discuss how we can help!

Any feedback is more than welcome! We have introduced a github action which will keep the docs automatically up-to-date with new changes, I'd love to integrate that for you if you are interested.

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,

Not relevant:

• [x] Code passes all tests
• [ ] Unit tests provided for these changes
• [x] Documentation and docstrings added for these changes

Changes

• added diagram documentation of the codebase

[ivanmilevtues]

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