[Documentation] Visualization of the slackminion project#74
Open
ivanmilevtues wants to merge 1 commit intopinterest:masterfrom
Open
[Documentation] Visualization of the slackminion project#74ivanmilevtues wants to merge 1 commit intopinterest:masterfrom
ivanmilevtues wants to merge 1 commit intopinterest:masterfrom
Conversation
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 slackminion project.
I can see that you keep your
docas .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.