Visualization for gpt-reasearch's codeabse #1446
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
Hey, a quick update on our side, we have released our diagram generation engine as an open-source repo: https://github.com/CodeBoarding/CodeBoarding If you are interested to see how exactly we combined Static Analysis and LLMs you can head and see that there! |
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 generated diagram for the gpt-researcher repo (via static analysis and LLMs): https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gpt-researcher/on_boarding.md
The diagram is intended to provide a high-level overview of the codebase by outlining the main components and their interactions. With this context, new contributors can more easily understand how the part they’re working on fits into the broader system.
I’d love to hear your thoughts on diagram-first documentation. Given that your project has over 3k forks, it's clear that many developers explore and contribute to your codebase. I'm curious—what has your experience been like with onboarding and maintenance? Is there any way I could help?
Just to be transparent: we’re in the early stages of building a startup around this idea, trying to figure out what’s genuinely helpful for developers. We’ve also heard concerns that diagrams can quickly become outdated, so we’ve added a free GitHub Action to help keep them up to date automatically!
Beta Was this translation helpful? Give feedback.
All reactions