Adding an interactive diagram representation for easier code-exploration #301
Closed
ivanmilevtues
started this conversation in
Ideas
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.
Here is the diagram:
graph LR Application_Services["Application Services"] Domain_Model["Domain Model"] Repository["Repository"] Event_Persistence_Layer["Event Persistence Layer"] Event_Consumption_Layer["Event Consumption Layer"] Application_Services -- "Issues Commands To" --> Domain_Model Domain_Model -- "Emits Events To" --> Application_Services Application_Services -- "Uses To Load/Save Aggregates" --> Repository Repository -- "Persists Events/Snapshots To" --> Event_Persistence_Layer Repository -- "Retrieves Events/Snapshots From" --> Event_Persistence_Layer Application_Services -- "Publishes Events To" --> Event_Consumption_Layer Event_Consumption_Layer -- "Reads Events From" --> Event_Persistence_Layer click Application_Services href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/eventsourcing/Application_Services.md" "Details" click Event_Persistence_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/eventsourcing/Event_Persistence_Layer.md" "Details" click Event_Consumption_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/eventsourcing/Event_Consumption_Layer.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/eventsourcing/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