Visualization of the target-python-sdk codebase #42
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.
Description
I am adding high-level diagram driven documentation for the target-python-sdk project. You can see how they render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/target-python-sdk/on_boarding.md
Related Issue
Motivation and Context
Me and a friend are working on automatically generating documentaiton so that people can get up-to-speed with new codebases. We believe that visualizaiton is the best way to go, and as we know how tedious is to keep up-to-date docs we are generating them leveraging static analysis and LLMs.
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.
How Has This Been Tested?
Screenshots (if appropriate):
You can see how the diagrams look here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/target-python-sdk/on_boarding.md
Types of changes
Checklist: