Skip to content

docs!: Code visualization for sendgrid-python #1110

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

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

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

If you have questions, please file a support ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant