AfterQC icon indicating copy to clipboard operation
AfterQC copied to clipboard

Visualization of the AfterQC codebase

Open ivanmilevtues opened this issue 6 months ago • 1 comments

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

These diagrams are designed to help people quickly understand a codebase. There are a lot of scientists who engage with this codebase, and we want to help them get up-to-speed faster. We believe that visuals are the easiest way to do that. With the diagrams they can immediately gain context and find the component in which they are interested and get knowledge of that and see what files are connected to it. I am super curious to hear what you think about diagram first documentation. I'd usually first open a discussion, but they are not enabled for this repo, so I went ahead and opened a PR.

Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the documentation.

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.

ivanmilevtues avatar Jun 16 '25 23:06 ivanmilevtues

A quick update! CodeBoarding is now fully open-source: https://github.com/CodeBoarding/CodeBoarding If interested you can go and check exaclty how the diagrams are generated <3

ivanmilevtues avatar Aug 02 '25 18:08 ivanmilevtues