pinterest
[Documentation] Visualization of the python logic in snappass
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.
Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding