I generated an interactive diagram for the injector project #280
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. But at the very begining I found it a bit too difficult to navigate them and wrap my head around on the main flow and the main "logical" components. That is why I started working on a project to help people like me, who are visual learners. The project generates an interactive diagram starting from the highest level of abstraction and allows you to dive deeper into interesting components.
This is the highest level of abstraction for the injector project:
graph LR Injector_Core["Injector Core"] Binding_Module_Configuration["Binding & Module Configuration"] Binding_Resolution_Logic["Binding Resolution Logic"] Provider_Management["Provider Management"] Dependency_Injection_Execution["Dependency Injection Execution"] Error_Handling_Lifecycle["Error Handling & Lifecycle"] Binding_Module_Configuration -- "feeds configuration data to" --> Injector_Core Injector_Core -- "requests binding from" --> Binding_Resolution_Logic Binding_Resolution_Logic -- "directs instance creation via" --> Provider_Management Provider_Management -- "returns instantiated objects to" --> Injector_Core Injector_Core -- "initiates injection process in" --> Dependency_Injection_Execution Dependency_Injection_Execution -- "queries for dependencies from" --> Binding_Resolution_Logic Binding_Resolution_Logic -- "signals errors to" --> Error_Handling_Lifecycle Dependency_Injection_Execution -- "signals errors to" --> Error_Handling_Lifecycle Injector_Core -- "propagates errors to" --> Error_Handling_Lifecycle click Injector_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/injector/Injector_Core.md" "Details" click Binding_Module_Configuration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/injector/Binding_Module_Configuration.md" "Details" click Binding_Resolution_Logic href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/injector/Binding_Resolution_Logic.md" "Details" click Provider_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/injector/Provider_Management.md" "Details" click Dependency_Injection_Execution href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/injector/Dependency_Injection_Execution.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 here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/injector/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