# octagonemusic/i3-dots architecture

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

- Interactive diagram: https://gitdiagram.com/octagonemusic/i3-dots
- Repository: https://github.com/octagonemusic/i3-dots

## Overview

##### Main components
- Repository Root ("i3-dots"): Acts as the central hub containing all submodules.
- Individual Application Configuration Folders:
- alacritty (terminal emulator config)
- dunst (notification daemon config)
- fastfetch (system information tool config)
- gtk-2.0 and gtk-3.0 (GTK settings for themes and UI)
- i3 (window manager config)
- picom (compositor config)
- polybar (status bar config)
- rofi (launcher/menu config)
- GNU Stow: Represent the tool used to manage symlinks from the repository to the user’s home directory.

- At the center, show the local repository ("i3-dots") which houses all dotfiles organized by application.

##### Architectural Patterns and Design Principles
- Modularity: Each application’s configuration is in its separate directory. This modular design allows selective symlinking using stow.
- Separation of concerns: Although all configurations are managed in one repository, each type of application is separated by its folder (for example, i3 configurations are entirely within the “i3” directory, polybar in “polybar”, and so on).
- Simplicity & Reusability: The use of a tool like stow emphasizes the reuse of configuration files while keeping the home directory uncluttered.

- Clear labels for each component (each configuration folder as a separate entity).
- Configuration repositories (group these together).
- Target system (the home directory) where symlinks are applied.
- Optional: Indicate minor components or extra configuration detail files (like the backup files or additional configuration snippets) if it helps in understanding the modular setup.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Repository Root
    Repo["i3-dots (Repository Root)"]:::repo

    %% Configuration Modules Subgraph
    subgraph "Configuration Modules"
        A["alacritty"]:::module
        D["dunst"]:::module
        F["fastfetch"]:::module
        G2["gtk-2.0"]:::module
        G3["gtk-3.0"]:::module
        I["i3"]:::module
        Pc["picom"]:::module
        P["polybar"]:::module
        Rf["rofi"]:::module
    end

    %% User's Home Directory
    Home["User's Home Directory"]:::home

    %% Relationships from Repository Root to each module
    Repo --> A
    Repo --> D
    Repo --> F
    Repo --> G2
    Repo --> G3
    Repo --> I
    Repo --> Pc
    Repo --> P
    Repo --> Rf

    %% Deployment: Each module is deployed to Home via GNU Stow
    A -->|"stow-t-~"| Home
    D -->|"stow-t-~"| Home
    F -->|"stow-t-~"| Home
    G2 -->|"stow-t-~"| Home
    G3 -->|"stow-t-~"| Home
    I -->|"stow-t-~"| Home
    Pc -->|"stow-t-~"| Home
    P -->|"stow-t-~"| Home
    Rf -->|"stow-t-~"| Home

    %% Click Events
    click Repo "https://github.com/octagonemusic/i3-dots/blob/main/README.md"
    click A "https://github.com/octagonemusic/i3-dots/tree/main/alacritty/"
    click D "https://github.com/octagonemusic/i3-dots/tree/main/dunst/"
    click F "https://github.com/octagonemusic/i3-dots/tree/main/fastfetch/"
    click G2 "https://github.com/octagonemusic/i3-dots/tree/main/gtk-2.0/"
    click G3 "https://github.com/octagonemusic/i3-dots/tree/main/gtk-3.0/"
    click I "https://github.com/octagonemusic/i3-dots/tree/main/i3/"
    click Pc "https://github.com/octagonemusic/i3-dots/tree/main/picom/"
    click P "https://github.com/octagonemusic/i3-dots/tree/main/polybar/"
    click Rf "https://github.com/octagonemusic/i3-dots/tree/main/rofi/"

    %% Styles
    classDef repo fill:#b3d9ff,stroke:#1f78b4,stroke-width:2px;
    classDef module fill:#ffd699,stroke:#e69138,stroke-width:2px;
    classDef home fill:#c9f9c9,stroke:#00a000,stroke-width:2px;
```
