Visualizaiton of the python-gitlab codebase #3214
ivanmilevtues
started this conversation in
Show and tell
Replies: 0 comments
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 have generated a high-level diagram for the python-gitlab project. You can check it here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-gitlab/on_boarding.md
Me and a friend are trying to help contributors to get up-to-speed with new codebases. We believe that visuals are the way to go, further we think that high-level understanding is crucial before diving deep into interesting component of the system - hence our abstract to more details diagram. We leverage static analysis and LLMs to generate it. I would love to hear what people think about diagram first documentation!
Any feedback is more than welcome, if you like what you see I will be more than happy to create a PR :)
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