Skip to content

Conversation

@ivanmilevtues
Copy link

@ivanmilevtues ivanmilevtues commented Jun 9, 2025

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

  • I have updated the CHANGELOG (if applicable)
  • I have followed the Shopify Python guide

@ivanmilevtues ivanmilevtues closed this by deleting the head repository Jun 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant