Visualization of the fail2ban codebase for new contirbutors #4019
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 1 comment
-
Hey a quick update, if you are interested to see how exactly the diagram generation works, you can take a look at our generation engine which 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'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 fail2ban:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fail2ban/on_boarding.md
The fail2ban has 1.3K forks, so there are a lot of people who interact with the codebase not only as users but also as developers. We believe that usually they want to modify just a component or two, which is of their interest. This said we think that with the diagram they can quickly navigate and understand the flow and how the component of interest integrates with the rest of the system.I would love to hear what you think on the idea, we've also just introduced a github action to keep those generations up-to-date!
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