Visualization of the spleeter codebase #939
Open
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.
Pull request title
Description
This PR contains high-level diagrams for the spleeter's codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/spleeter/on_boarding.md
The goal is to help new people get up-to-speed faster with the codebase. We think that at the beginning seeing the big picture is very important. This said we think that diagrams are the best way to represent initially codebase, this way new contributors will get context and they can focus on the component of interest. I would love to hear what your current process of familiarizing people with the codebase is, can these diagram be integrated in it?
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!
How this patch was tested
You tested it, right?
Not relevant
poetry run pytest tests/
poetry run black spleeter
Documentation link and external references
You can see how the diagram and documentation render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/spleeter/on_boarding.md