- Notifications
You must be signed in to change notification settings - Fork772
docs: Visualziation of the twilio codebase#868
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
ivanmilevtues wants to merge1 commit intotwilio:mainChoose a base branch fromCodeBoarding:main
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
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
Hi@ivanmilevtues! Thank you so much for raising this PR. I'll try to review and merge it at the earliest. Thanks! |
Also, can you sync it with new changes in our main? Thanks! |
Sign up for freeto 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.
Fixes
In this PR I have added high-level diagrams for new people to get up-to-speed with the twilio-python codebase.
You can see how they will render here:https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/twilio-python/on_boarding.md
Me and a friend are working on this diagrams as we think this is the best way to get up-to-speed with new codebases. The way we generate them is via Static Analysis and LLMs. 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.
Checklist
If you have questions, please file asupport ticket, or create a GitHub Issue in this repository.