Diagram representation of the zipline's codebase #2861
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains high-level diagram representation of the zipline codebase. You can see how the diagrams render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/spleeter/on_boarding.md
These diagrams are designed to help new people get up-to-speed with the zipline codebase. I would love to hear what do you think of diagram first documentation. Do you have a current on-boarding process at the moment with which we can help? We believe that diagrams give a good high-level context of how the project works, then a person can focus on a component of interest.
Any feedback is more than welcome! We've just released a free GitHub Action that can automatically update the diagrams and this way keep them 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.
I would usually start by opening a discussion, but they are not enabled for this repository so I opened a PR instead!