Repository navigation
An interactive diagram for timetaggers codebase for easier onboarding #559
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 Web_Server_Orchestrator["Web Server & Orchestrator"] Backend_API_Services["Backend API Services"] Static_Asset_Management["Static Asset Management"] Client_Side_Application["Client-Side Application"] Authentication_Authorization["Authentication & Authorization"] Application_Configuration["Application Configuration"] Web_Server_Orchestrator -- "routes dynamic API requests to" --> Backend_API_Services Web_Server_Orchestrator -- "requests and serves assets from" --> Static_Asset_Management Client_Side_Application -- "initiates data requests with" --> Backend_API_Services Backend_API_Services -- "responds to data requests from" --> Client_Side_Application Backend_API_Services -- "validates API requests with" --> Authentication_Authorization Authentication_Authorization -- "manages user sessions for" --> Backend_API_Services Client_Side_Application -- "handles authentication with" --> Authentication_Authorization Authentication_Authorization -- "manages client-side tokens for" --> Client_Side_Application Application_Configuration -- "provides settings to" --> Web_Server_Orchestrator Application_Configuration -- "supplies configuration to" --> Backend_API_Services click Web_Server_Orchestrator href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/timetagger/Web_Server_Orchestrator.md" "Details" click Backend_API_Services href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/timetagger/Backend_API_Services.md" "Details" click Static_Asset_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/timetagger/Static_Asset_Management.md" "Details" click Client_Side_Application href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/timetagger/Client_Side_Application.md" "Details" click Authentication_Authorization href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/timetagger/Authentication_Authorization.md" "Details" click Application_Configuration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/timetagger/Application_Configuration.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/timetagger/on_boarding.md
Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!
All reactions