DeepGraphLearning
Visualization for the ConfGF codebase
This PR contains high-level diagrams for the ConfGF codebase. You can see how they render in Github here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/ConfGF/on_boarding.md
These diagrams are designed to help people quickly understand a codebase. I believe that a lot of scientists look into this repository. Our goal is to reduce the time it takes to get up to speed—from hours to just minutes—by using visuals (diagrams) instead of reading through the entire code. I'd love to hear what is your opinion on diagram-first documentation! Further as you are part of univeristy I believe that a lot of students can benefit from this, any this can reduce load from the supervisors, let me know if you think this can be the case!
We’d love any feedback! We also just released a free GitHub Action that can automatically update the diagrams.
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.
A quick update on our side! We are now fully open-source, you can check our diagram generation engine over here: https://github.com/CodeBoarding/CodeBoarding