ragbits' codebase visualization #605
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
A quick update: CodeBoarding is open-source now - 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 am Ivan and toghether with a friend we've noticed that it is quite hard to get-to-know new codebase. I think from both perspectives of a maintainer and contributor it can be hard to have nice documentation which is also up-to-date. Futher we think that the best place to start is a high-level diagram, so that one can get the big picture of structure/flow before diving deep into interesting/relevant component.
This said I have generated one for the ragbit codebase and would love to hear what you think about it:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/ragbits/on_boarding.md
We leverage Static Analysis and LLMs to generate the diagrams :)
Any sort of feedback is more than welcome!
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