docs: Visualziation of the twilio codebase#868
Open
ivanmilevtues wants to merge 2 commits intotwilio:mainfrom
Open
docs: Visualziation of the twilio codebase#868ivanmilevtues wants to merge 2 commits intotwilio:mainfrom
ivanmilevtues wants to merge 2 commits intotwilio:mainfrom
Conversation
Contributor
|
Hi @ivanmilevtues! Thank you so much for raising this PR. I'll try to review and merge it at the earliest. Thanks! |
Contributor
|
Also, can you sync it with new changes in our main? Thanks! |
Author
|
Thanks for the response and your time @tiwarishubham635! I synced the repo, I am looking forward to your feedback and response. More than happy to collaborate and push this through |
Author
|
Hey @tiwarishubham635, wanted to drop by and update you that the diagram generation engine 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
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 a support ticket, or create a GitHub Issue in this repository.