Diagram representation of the OpenBB codebase #7147
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'm Ivan, and together with a friend, we're working on making it easier for everyone to understand new codebases. We believe visualization is key, so we're creating diagram-first documentation. To achieve this, we use static analysis and LLMs. Here's one I generated for OpenBB:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/OpenBB/on_boarding.md
OpenBB has over 3.8K forks, which shows there's a strong community of developers engaging with the codebase—not just as users, but as contributors as well. From what we've seen, most of them are typically interested in modifying one or two components that are relevant to their specific needs.
With that in mind, we believe having a high-level diagram makes it much easier to navigate the system and quickly understand how a specific component fits into the broader architecture. To support this, we've also recently introduced a GitHub Action that keeps the diagrams automatically up-to-date with the latest changes.
We’d love to hear your thoughts on this approach. Also, how do you currently onboard new contributors to the codebase? If there's any way we can help streamline that process, we'd be happy to collaborate.
If you like the diagrams I'd be more than happy to open a PR!
Any 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