Diagram visualization of the pipenv codebase #6422
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.
-
Hi all, I've generated (using static analysis and LLMs) a diagram representation of the pipenv project. You can see it here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pipenv/on_boarding.md
These diagrams are designed so that they can give an overview of the main components of they codebase and how they interact with each other. We believe that the best way to get started on a project is by starting small, however with the big picture. The diagram gives you a high-level understanding and then when you go into a component you can again see how the component is arranged and find the relevant source files. So when you start working on your task you'd know how it fits in the big picture.
I'd love to hear what you have to say about diagram first documentation!
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. We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
Beta Was this translation helpful? Give feedback.
All reactions