# miguelinux/slides architecture

> Architecture diagram of the GitHub repository miguelinux/slides, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/miguelinux/slides
- Repository: https://github.com/miguelinux/slides

## Overview

##### Main Components
- Educational Content Modules: Represented by top-level directories for each subject or technology. These include:
- HTML: Contains introductory topics, style guides, text formatting, tables, lists, forms, and sample HTML pages.
- JavaScript: Multiple sections on topics like introduction, syntax, variables, control structures, and more.
- Linux: Covers various Linux-related subjects (commands, networking, containers, security like 2FA, etc.) and even container and networking examples.
- Python: Contains installation guides, tutorials ranging from introduction to functions, modules, and file handling.
- Git: Provides Git & GitHub related teaching resources.
- Pláticas: Includes presentations and teaching slides for various events.
- LaTeX and Common: These directories contain shared resources, style files, common texts, and templates used across the slides and documentation.
- Utility and Build Tools:
- Scripts: Shell scripts for operations like changing file dates, cleaning auxiliary files, generating press materials, or verifying TeX filenames.
- Pre-commit configurations (in the python/pre-commit folder) that likely help in ensuring quality or consistency.
- Assets and Styles:
- Images and styles: There are several asset directories (e.g., for HTML images, LaTeX images, style files) that support the visual and formatting aspects of the content.
- Licensing and Metadata:
- Root-level files such as .gitignore, LICENSE, and README provide meta information and licensing details for the entire repository.

##### Relationships and Interactions
- Content Modules Dependence: Each individual technology or topic folder (HTML, JavaScript, Linux, Python, etc.) represents a self-contained module. They may refer to shared styling and configurations from the “common” folder and might use the images placed in their respective “img” subdirectories.
- Scripts and Automation: The “scripts” folder interconnects with many parts of the repository by automating tasks across the project (e.g., cleaning, validating, date change for TeX files) to maintain consistency of the educational materials.
- Integration for Presentations: The “platicas” directory indicates the use of these materials in live talks or workshops. It leverages both common templates and subject-specific content.

##### Architectural Patterns and Design Principles
- Modularity: The repository is clearly modular, with each subject or technology kept in its own directory. This makes it easy to update or extend one subject without affecting others.
- Separation of Content and Assets: Teaching materials are separated from supporting assets like images, scripts, and common styles.
- Reusability: The “common”, “styles”, and “templates” directories indicate a DRY (Don’t Repeat Yourself) principle applied across various modules.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Educational Modules"
        htmlMod["HTML Module"]:::module
        jsMod["JavaScript Module"]:::module
        linuxMod["Linux Module"]:::module
        pythonMod["Python Module"]:::module
        gitMod["Git Module"]:::module
        platMod["Pláticas Module"]:::module
    end

    subgraph "Shared Resources & Assets"
        commonRes["Common Resources"]:::shared
        latexSlides["LaTeX Slides"]:::shared
        htmlImg["HTML Images"]:::asset
        latexImg["LaTeX Images"]:::asset
        platImg["Pláticas Images"]:::asset
        styles["Styles"]:::asset
    end

    subgraph "Automation & Tools"
        scripts["Scripts / Automation"]:::automation
        precommit["Pre-commit Config"]:::automation
    end

    %% Educational Modules depend on Shared Resources & Assets
    htmlMod -->|"uses"| commonRes
    htmlMod -->|"uses"| htmlImg
    htmlMod -->|"uses"| styles

    jsMod -->|"uses"| commonRes
    jsMod -->|"uses"| styles

    linuxMod -->|"uses"| commonRes
    linuxMod -->|"uses"| styles

    pythonMod -->|"uses"| commonRes
    pythonMod -->|"uses"| styles

    gitMod -->|"uses"| commonRes
    gitMod -->|"uses"| styles

    platMod -->|"uses"| commonRes
    platMod -->|"uses"| platImg
    platMod -->|"uses"| styles
    platMod -->|"uses"| latexSlides

    %% Automation Tools interface with modules and shared resources
    scripts -->|"automates"| htmlMod
    scripts -->|"automates"| jsMod
    scripts -->|"automates"| linuxMod
    scripts -->|"automates"| pythonMod
    scripts -->|"automates"| gitMod
    scripts -->|"automates"| platMod
    scripts -->|"updates"| commonRes
    scripts -->|"updates"| latexSlides

    precommit -->|"ensures"| pythonMod

    %% Styles for nodes
    classDef module fill:#AED6F1,stroke:#2471A3,stroke-width:2px;
    classDef shared fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef asset fill:#D5F5E3,stroke:#1D8348,stroke-width:2px;
    classDef automation fill:#FAD7A0,stroke:#D35400,stroke-width:2px;

    %% Click Events
    click htmlMod "https://github.com/miguelinux/slides/tree/main/html"
    click jsMod "https://github.com/miguelinux/slides/tree/main/javascript"
    click linuxMod "https://github.com/miguelinux/slides/tree/main/linux"
    click pythonMod "https://github.com/miguelinux/slides/tree/main/python"
    click gitMod "https://github.com/miguelinux/slides/tree/main/git"
    click platMod "https://github.com/miguelinux/slides/tree/main/platicas"
    click commonRes "https://github.com/miguelinux/slides/tree/main/common"
    click latexSlides "https://github.com/miguelinux/slides/tree/main/latex"
    click scripts "https://github.com/miguelinux/slides/tree/main/scripts"
    click precommit "https://github.com/miguelinux/slides/tree/main/python/pre-commit"
    click htmlImg "https://github.com/miguelinux/slides/tree/main/html/img"
    click latexImg "https://github.com/miguelinux/slides/tree/main/latex/img"
    click platImg "https://github.com/miguelinux/slides/tree/main/platicas/img"
    click styles "https://github.com/miguelinux/slides/tree/main/styles"
```
