[Documentation] Visualization of the python logic in snappass #439
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.
In this PR, I am adding a diagram visualizaiton for the snappass project.
It seems like the README.md is your main documentation point, so I can link the visualization there if you like it!
You can see how the diagrams in this change render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/snappass/on_boarding.md
The goal of these documents is to help people get up to speed quickly with the git-stacktrace codebase. The diagrams are designed to give immediate overview of the codebase and allow you to dig deeper into each component of interest. The whole visualization is generated so it is easy to keep up-to-date. The generation is done via StaticAnalysis and LLMs - that's why for now it covers the python part of the source code.
Would love to connect and discuss how can we help the people who work and contributo to pinterest's codebase. We are curious to hear how do you keep docs up-to-date so that people can get up-to-speed to different projects within the company!
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.
Further I we also have a free github action to keep the whole thing up-to-date with new commits.