Visualization for the supervision codebase #1859
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
Hey a quick update on our side, our generation engine is now open source: https://github.com/CodeBoarding/CodeBoarding |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hey all, I've generated a diagram visualization of the supervesion codebase:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/supervision/on_boarding.md
The diagrams are designed to help new contributors get up-to-speed faster. I saw that you have 2k+ forks, that means that a lot of people are playing with the codebase. Usually such contributors are interested in one or two submodules (for a start). This said we believe that this is a perfect example of how the diagram is useful. It gives you high-level understanding of what the different component of the codebase are and how they interact with each other. Then one can decide which component is the one of interest and dig deeper into its structure, then the diagram also provides the related source code, so one can start developing from there. Now the development is with much more context, the contributor knows the bigger picture and how the component interacts with the rest of the codebase.
Let me know if this sounds intersting to you! If you like the diagram I'd be more than happy to open a PR!
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
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.
Beta Was this translation helpful? Give feedback.
All reactions