docs!: Code visualization for sendgrid-python #1110
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
Hi, I have generated documentation to help new developers to get up to speed with the sendgird-python codebase.
I've noticed how intimidating it can be for new devs to pick up existing codebases, further maintainers have a lot on their plate already to answer constantly question from new devs (if the dev even makes it to ask questions). This said me and a friend decided to try and build something that can help in this regards. We believe visualization is always an amazing start when starting with new codebase. For us visualization for codebase means diagrams - I would love to hear if you agree with us and if you already have some sort of on-boarding process, what is it? Can our diagrams fit into it?
This said, we leverage static analysis and LLM's to generate diagrams and the one for the sendgrid-python repository is in this PR.
To see how the added change renders in the github markdown you can check this link:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sendgrid-python/on_boarding.md
I would be more than happy to get your opinion on the diagrams and if they can bring value for your repository. A big deal of the generation is the idea that they can be always up-to-date i.e. generated whenever a new change is added to main or some other heuristic!
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.