Visualization of the pinterest-python-sdk codebase #151
Conversation
|
Hey @ivanmilevtues, thanks for the contribution! I will discuss with the maintainers if this is something we want to add to the repo. Initial question: can you point out how we can keep this? Also, how can we generate this from other projects? I want to understand this a little better to discuss with my peers. |
|
Thank you for the response @dfana0, I am thrilled that you are interested! At the moment you can generate such diagrams from our website's demo page: https://www.codeboarding.org/demo On how you can keep this - for github we will be looking into if we can make a worflow action which can be run whenever you decide is appropriate for a small monthly fee (probably it will be free at first). We will love to build the action with few early adopters (possibly your project) and then get iterative feedback from you! I am also down to have a short chat if you are interested in doing so! Lmk if I answered your question and if you have others! |
|
Hey @dfana01, Further we now have a free Github Action and I will be more than happy to integrate it for you! For the other projects you can generate via our UI and I will take iniative and open PRs to other projects within the org. Let me know if you had change to chat with your peers, and if I can help in any way! Happy to connect and discuss this topic! |
|
Hi coming in to update you that now CodeBoarding is an open-source project: https://github.com/CodeBoarding/CodeBoarding |
2 participants
In this change I've added high-level diagrams for the pinterest-python-sdk.
Me and a friend noticed how hard it could be to on-board yourself into an existing project, so we are on a quest to help maintainers and new devs to optimize this process. We believe that at the begining just getting a grasp of the data flow/architecture is the best thing one can do. So this is why we started by generating high-level diagrams for project. I would love to hear what do you think on this, I suppose that in pinterest there are a lot of people who jump onto projects and move around!
This said, for our diagram generation we use static analysis and LLM's to generate diagrams. I generated one for the pinterest-python-sdk project.
You can see how the added change will render in Github here - https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pinterest-python-sdk/on_boarding.md
I would love to hear your opinion on diagram first documentation and especially on our diagram.
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.