Visualization of the prefect codebase #18333
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.
-
I have generated high-level diagrams for the prefect project:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/prefect/on_boarding.md
These diagrams are designed to help people get up-to-speed with the codebase. Considering your almost 2k forks, there are a lot of contributors, I suppose that most of them are interested in just one component of the full codebase. This is why we also believe that diagrams are best, as they give the full picture and allow you to narrow down the component (and its related source) is interesting to you. Then you can expand that component and familiarize yourself with it having the big picture of how it interacts within the full codebase.
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
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