I generated an interactive diagram for python-opcua

[ivanmilevtues]

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 python-opcua project:

graph LR
    OPC_UA_Client["OPC UA Client"]
    OPC_UA_Server["OPC UA Server"]
    OPC_UA_Protocol_Core["OPC UA Protocol Core"]
    Security_Cryptography["Security & Cryptography"]
    Code_Generation_Schema_Tools["Code Generation & Schema Tools"]
    CLI_Tools["CLI Tools"]
    CLI_Tools -- "Invokes Operations" --> OPC_UA_Client
    CLI_Tools -- "Invokes Operations" --> OPC_UA_Server
    OPC_UA_Client -- "Uses Protocol Services" --> OPC_UA_Protocol_Core
    OPC_UA_Client -- "Applies Security" --> Security_Cryptography
    OPC_UA_Server -- "Uses Protocol Services" --> OPC_UA_Protocol_Core
    OPC_UA_Server -- "Applies Security" --> Security_Cryptography
    OPC_UA_Server -- "Responds to Requests" --> OPC_UA_Client
    Code_Generation_Schema_Tools -- "Generates Protocol Structures" --> OPC_UA_Protocol_Core
    Code_Generation_Schema_Tools -- "Generates Address Space" --> OPC_UA_Server
    click OPC_UA_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-opcua/OPC_UA_Client.md" "Details"
    click OPC_UA_Server href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-opcua/OPC_UA_Server.md" "Details"
    click OPC_UA_Protocol_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-opcua/OPC_UA_Protocol_Core.md" "Details"
    click Security_Cryptography href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-opcua/Security_Cryptography.md" "Details"
    click Code_Generation_Schema_Tools href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-opcua/Code_Generation_Schema_Tools.md" "Details"

Loading

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/python-opcua/on_boarding.md

Any feedback is appreciated! Would love to hear your opinion on diagrams as an exploration tooling and diagram first documentation!