Skip to content

[Documentation] Visualization of the slackminion project#74

Open
ivanmilevtues wants to merge 1 commit intopinterest:masterfrom
CodeBoarding:master
Open

[Documentation] Visualization of the slackminion project#74
ivanmilevtues wants to merge 1 commit intopinterest:masterfrom
CodeBoarding:master

Conversation

@ivanmilevtues
Copy link

In this PR, I am adding a diagram visualizaiton for the slackminion project.
I can see that you keep your doc as .rst files and use Sphinx to build them. I can integrate the diagrams within those if you like them (also we have a free github action to keep the whole thing up-to-date with new commits).

You can see how the diagrams in this change render here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/slackminion/on_boarding.md

The goal of these documents is to help people get up to speed quickly with the git-stacktrace codebase.
I can see that the project has been inactive for 3 years, this is a great opportunity to have documentation so that if someone wants to make use of the project now or later they will know where to start and what is going on with it!
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.

Would love to connect and discuss if this is something interesting to pinterest, and how do you keep docs up-to-date so that people can get up-to-speed to different projects across pinterest!

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.

@ivanmilevtues ivanmilevtues requested a review from a team as a code owner July 9, 2025 00:14
@ivanmilevtues ivanmilevtues changed the title Added high-level diagrams [Documentation] Visualization of the slackminion project Jul 9, 2025
@ivanmilevtues
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant