Add shopify_python_api codebase visualizaiton #777
Closed
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.
WHY are these changes introduced?
Documentation to make for new contributors to get up-to-speed with the exsting codebase.
You can see how the change will render if merged here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/shopify_python_api/on_boarding.md
Me and a friend are thinking that diagram first documentaiton is the best way to get a new person started onto existing codebase so that is why we are building something which allows you to automatically generate such diagrams based on Static Analysis and LLMs.
I would love to hear if this fits your existing onboarding processes in Shopify, further any feedback is more than welcome!
WHAT is this pull request doing?
Gives an abstract diagram genreation for the codebase at this moment. If you find this interesting you can just merge it in. We are currently working on Github Action so that you can generate based on certain heuristics (merge in main/release/etc)
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