Visualizatiion for the python-twitch-client codebase#80
Open
ivanmilevtues wants to merge 1 commit intotsifrer:masterfrom
Open
Visualizatiion for the python-twitch-client codebase#80ivanmilevtues wants to merge 1 commit intotsifrer:masterfrom
ivanmilevtues wants to merge 1 commit intotsifrer:masterfrom
Conversation
Author
|
A quick update https://github.com/CodeBoarding/CodeBoarding is now open-source! |
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
1 participant
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 diagrams for the python-twitch-client.
You can see how the render in the github UI here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-twitch-client/on_boarding.md
Me and my friend leverage static analysis and LLMs to build such diagrams, we think that they are the best way for a new person to get up-to-speed with the codebase. Having such visuals gives you imidiate context on what are the main components and how they interact with each other! Further by generating them, they can easily be maintained as up-to-date, we are currently working on a github action to do that!
Any feedback is more than welcome!
I would usually open a discussion first, but they don't seem to be enabled for this project, so decided to go ahead and crear 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.