[docs] Visualization of the SRAgent's codebase#10
Open
ivanmilevtues wants to merge 1 commit into
Open
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
1 participant
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.
This PR adds documents with Mermaid diagrams that provide a high-level overview of the codebase. You can see an example here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/SRAgent/on_boarding.md
The goal is to make it easier for people to modify and use the SRAgents codebase. A friend and I are working on improving the "getting to know the code" phase, especially for scientists who use code as a tool but aren't software engineers.
I would love to hear your feedback on the diagrams! If you like them, we can merge this PR and I can also integrate our free Github Action which will keep them up-to-date.
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.