Adding an interactive diagram to explore the codebase #281
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.
-
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 Simulation_Core["Simulation Core"] RL_Environment_Interface["RL Environment Interface"] Drone_Control_Modules["Drone Control Modules"] SITL_Integration["SITL Integration"] Drone_Model_Asset_Management["Drone Model & Asset Management"] RL_Environment_Interface -- "Sends Actions To" --> Simulation_Core Simulation_Core -- "Provides State To" --> RL_Environment_Interface Drone_Control_Modules -- "Generates Actions For" --> RL_Environment_Interface RL_Environment_Interface -- "Provides State To" --> Drone_Control_Modules SITL_Integration -- "Applies Motor Commands To" --> Simulation_Core Simulation_Core -- "Provides Sensor Data To" --> SITL_Integration Drone_Model_Asset_Management -- "Configures" --> Simulation_Core click Simulation_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gym-pybullet-drones/Simulation_Core.md" "Details" click RL_Environment_Interface href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gym-pybullet-drones/RL_Environment_Interface.md" "Details" click Drone_Control_Modules href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gym-pybullet-drones/Drone_Control_Modules.md" "Details" click SITL_Integration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gym-pybullet-drones/SITL_Integration.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/gym-pybullet-drones/on_boarding.md
Any feedback is appreciated! If you like it I would be more than happy to open a PR with all the diagrams and a free github action to keep them up-to-date.
Beta Was this translation helpful? Give feedback.
All reactions