I generated an interactive diagram representation of Name-That-Hash's codebase #152
Closed
ivanmilevtues
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hey, all I've always wanted to contribute to open-source projects. I am a visual learner, so I love doing diagrams for myself as in the beggining I find it hard to wrap my head around the main flow and the main "logical" components.
To help people who like visual represnetations I started working on a project to automate this. The tool generates an interactive diagram starting from the highest level of abstraction and allows you to dive deeper into interesting components.
Here is the diagram:
graph LR Application_Interfaces["Application Interfaces"] Hash_Input_Processing["Hash Input Processing"] Hash_Identification_Core["Hash Identification Core"] Hash_Definitions_Models["Hash Definitions & Models"] Output_Formatting_Presentation["Output Formatting & Presentation"] Application_Interfaces -- "Provides Input" --> Hash_Input_Processing Hash_Input_Processing -- "Sends Prepared Hashes" --> Hash_Identification_Core Hash_Identification_Core -- "Consults Rules" --> Hash_Definitions_Models Hash_Identification_Core -- "Provides Identified Hashes" --> Output_Formatting_Presentation Output_Formatting_Presentation -- "Returns Formatted Output" --> Application_Interfaces click Application_Interfaces href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/Name-That-Hash/Application_Interfaces.md" "Details" click Hash_Definitions_Models href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/Name-That-Hash/Hash_Definitions_Models.md" "Details"The generation tool is based on Static Analysis and LLMs and is fully open-source: https://github.com/CodeBoarding/CodeBoarding
You can see the full diagram with explanations and related source code here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/Name-That-Hash/on_boarding.md
Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!
Beta Was this translation helpful? Give feedback.
All reactions