Visualization of the square-python-sdk #156
Open
+751
−0
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.
Visualization of the square-pythno-sdk
I understand that this PR won't get merged. I usually would open a discussion on github, but since I don't need support and do not have really a feature request decided to open one. You can close it as soon as you feel like doing so.
This PR introduces high-level graph documentation for the sqyare-python-sdk. You can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/square-python-sdk/on_boarding.md
The goal of such diagram driven documentation is to help people get up-to-speed with new codebases. I would love to hear what is your current process when someone engages with your teams source code. We believe high-level understanding is crucial and just after that one can dive deeper into the interesting component. That is why we generate our diagrams in such fashion. For the generation we leverage Static Analysis and LLMs, and currently we are looking into creating a github actions so that people can generate these diagrams on demand.
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.
ATTENTION
This repository cannot accept Pull Requests. If you wish to proceed with opening this PR, please understand that your code will not be pulled into this repository. Consider opening an issue which lays out the problem instead. Thank you very much for your efforts and highlighting issues!
Please direct all technical support questions, feature requests, API-related issues, and general discussions to our Square-supported developer channels. For public support, join us in our Square Developer Discord server or post in our Developer Forums. For private support, contact our Developer Success Engineers directly.