Visualization of the undetected-chromedriver codebase #2206
ivanmilevtues
started this conversation in
Ideas
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 am Ivan and toghether with a friend of mine we are trying to help people get up-to-speed with new codebases.
I saw that already there have been discussions related to the codebase being hard to grasp. We think this is often the situation, and understand that it can be hard to create and maintain documentation. This is why we are trying to build something which generates documentation automatically.
We believe that Visuals are the best way to get started with something this is why we are generating high-level diagram first documentation. I generated one for this proejct, you can check it here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/undetected-chromedriver/on_boarding.md
As we know that LLMs can hallucinate, our generation is based on static analysis and then LLMs trying to minimize the hallucination also, it links to the relevant code, helping with navigation!
I would love to hear your opinion on the diagram and all sorts of feedback is more than welcome! If you think that what we've generated can be useful I'd be more than happy to make 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