[Show] An interactive diagram to explore the pokedex codebase

[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.

Here is the diagram:

graph LR
    CLI_Application_Layer["CLI Application Layer"]
    Data_Ingestion_Export_Layer["Data Ingestion & Export Layer"]
    Database_Core_Layer["Database Core Layer"]
    Search_Indexing_Layer["Search & Indexing Layer"]
    Raw_Data_Sources["Raw Data Sources"]
    Configuration_Utilities_Layer["Configuration & Utilities Layer"]
    Documentation_Generation_Layer["Documentation Generation Layer"]
    CLI_Application_Layer -- "triggers" --> Data_Ingestion_Export_Layer
    CLI_Application_Layer -- "triggers" --> Search_Indexing_Layer
    Data_Ingestion_Export_Layer -- "reads from" --> Raw_Data_Sources
    Data_Ingestion_Export_Layer -- "writes to" --> Database_Core_Layer
    Data_Ingestion_Export_Layer -- "writes to" --> Raw_Data_Sources
    Data_Ingestion_Export_Layer -- "extracts from" --> Database_Core_Layer
    Database_Core_Layer -- "provides data for" --> Search_Indexing_Layer
    Search_Indexing_Layer -- "queries" --> Database_Core_Layer
    Configuration_Utilities_Layer -- "provides services to" --> CLI_Application_Layer
    Configuration_Utilities_Layer -- "provides services to" --> Data_Ingestion_Export_Layer
    Configuration_Utilities_Layer -- "provides services to" --> Database_Core_Layer
    Configuration_Utilities_Layer -- "provides services to" --> Search_Indexing_Layer
    Documentation_Generation_Layer -- "inspects" --> Database_Core_Layer
    click CLI_Application_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pokedex/CLI_Application_Layer.md" "Details"
    click Data_Ingestion_Export_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pokedex/Data_Ingestion_Export_Layer.md" "Details"
    click Database_Core_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pokedex/Database_Core_Layer.md" "Details"
    click Search_Indexing_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pokedex/Search_Indexing_Layer.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 with explanations and related source code here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pokedex/on_boarding.md

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