# killerrat/.dotfiles architecture

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

- Interactive diagram: https://gitdiagram.com/killerrat/.dotfiles
- Repository: https://github.com/killerrat/.dotfiles

## Overview

This repository is a collection of dotfiles and configuration scripts meant to set up environments across multiple platforms (Linux, MacOS, and Windows). In essence, it’s a “meta-configuration” project where each directory configures aspects of the user’s environment – window managers, shell settings, application themes, and various system settings. The README confirms its multi-platform nature and emphasizes installation for different Linux distributions and even Neovim installation via a provided script.

##### Main Components
- Dotfiles Repository: At the top, consider the entire repository as the central configuration management system.
- Platform-specific Configuration Groups: Identify groupings for Linux (e.g., “install”, “hosts”, “i3-manjaro”, “bashrc”, “zshrc”), MacOS (e.g., “hosts/arch-agouwsmacbookpro”, “hosts/arch-macbookpro13”, “oh-my-posh”), and Windows (e.g., “windows-terminal” and PowerShell directories).
- Application and Tool Configurations: Include directories like “alacritty”, “conky”, “dunst”, “flameshot”, “nvim-lua”, “nerd-dictation”, “picom”, “ranger”, “skhd”, “tmux”, “yabai”, etc.
- Installation Scripts: The “install” directory and various shell scripts that automate setting up an OS environment.
- Documentation: The “docs” directory covering guides (e.g., i3 configuration, neovim tips) that underpin how the configs should be applied.

##### Relationships and Interactions
- The Installation Component drives the setup process – it pulls in various config files from their respective directories.
- Platform-specific configurations feed into the installation scripts by providing tailored configuration files and scripts (for example, separate hosts directories for different hardware like “arch-agouws”, “arch-asus”, “arch-delllatitude”).
- User Applications (e.g., Neovim, i3, tmux) have their configurations stored in dedicated directories. They can be shown as independent nodes connected to the central repository.
- Navigation tips and shared utilities (e.g., gitconfig, scripts) serve as common dependencies shared by multiple configurations.

##### Architectural Patterns & Design Principles
- Modularity: Each configuration is isolated in its own directory, allowing for ease of customization and platform-specific overrides.
- Separation of Concerns: There is a clear division between installation scripts, user configuration files, documentation, and even utility scripts.
- Extensibility: New configurations for additional tools or platforms can be added without disrupting existing ones.
- Consistency: File naming conventions and directory structures organized by tool (i3, bash, neovim, etc.) help in maintaining uniformity.

##### Relevant Technologies, Frameworks, & Tools
- Shell scripting: Many installation and setup scripts are written in bash or PowerShell.
- Package management hooks: The “pacman” directory suggests integration with the Arch Linux package manager for system hooks.
- Containerization: The “nvim-docker” component indicates Docker is used for certain configurations (specifically Neovim).
- System services: The hosts directories include systemd service files, showcasing integration with Linux service management.

##### Specific Elements
- Clear labels for each node/component (e.g., “Alacritty Config”, “i3 Config”, “Platform: Arch Configuration”, “Installation Scripts”).
- Annotations that identify key files within the directories (like “.bashrc” in the bashrc node, “config.yaml” in glazewm, or “docker-compose.yaml” in nvim-docker).

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Dotfiles Repository"]:::repository

    subgraph "Installation Group"
        B["Linux Installation Scripts"]:::installation
    end

    subgraph "Platform Configurations"
        C["Linux Platform Configs"]:::platform
        D["MacOS Configs"]:::platform
        E["Windows Configs"]:::platform
    end

    subgraph "Shell Configurations"
        F["Bash Config"]:::shell
        G["Zsh Config"]:::shell
    end

    subgraph "Application Configurations"
        H["Alacritty Config"]:::app
        I["i3 Config"]:::app
        J["Neovim Config"]:::app
        K["Dunst Config"]:::app
        L["Conky Config"]:::app
        M["Picom Config"]:::app
        N["Ranger Config"]:::app
        O["Yabai Config"]:::app
        P["Glazewm Config"]:::app
        Q["Nerd-dictation"]:::app
        R["Pacman Hooks"]:::app
        S["nvim-docker"]:::app
        T["LightDM Config"]:::app
        U["skhd Config"]:::app
    end

    subgraph "Utilities"
        V["Git Config"]:::utility
        W["SSH Config"]:::utility
        X["Scripts"]:::utility
    end

    subgraph "Documentation"
        Y["Documentation"]:::doc
    end

    %% Connections from Dotfiles Repository
    A --> B
    A --> C
    A --> D
    A --> E
    A --> F
    A --> G
    A --> H
    A --> I
    A --> J
    A --> K
    A --> L
    A --> M
    A --> N
    A --> O
    A --> P
    A --> Q
    A --> R
    A --> S
    A --> T
    A --> U
    A --> V
    A --> W
    A --> X
    A --> Y

    %% Connections from Installation Scripts to Configuration Components
    B --> C
    B --> D
    B --> E
    B --> F
    B --> G
    B --> H
    B --> I
    B --> J
    B --> K
    B --> L
    B --> M
    B --> N
    B --> O
    B --> P
    B --> Q
    B --> R
    B --> S
    B --> T
    B --> U
    B --> V
    B --> W
    B --> X
    B --> Y

    %% Styles
    classDef repository fill:#AED6F1,stroke:#1B4F72,stroke-width:2px;
    classDef installation fill:#F5B7B1,stroke:#922B21,stroke-width:2px;
    classDef platform fill:#D2B4DE,stroke:#6C3483,stroke-width:2px;
    classDef shell fill:#A9DFBF,stroke:#1D8348,stroke-width:2px;
    classDef app fill:#FCF3CF,stroke:#7D6608,stroke-width:2px;
    classDef utility fill:#F9E79F,stroke:#7D6608,stroke-width:2px;
    classDef doc fill:#AED6F1,stroke:#1B4F72,stroke-width:2px;

    %% Click Events
    click A "https://github.com/killerrat/.dotfiles/blob/master/."
    click B "https://github.com/killerrat/.dotfiles/tree/master/install/"
    click C "https://github.com/killerrat/.dotfiles/tree/master/hosts/"
    click D "https://github.com/killerrat/.dotfiles/tree/master/oh-my-posh/"
    click E "https://github.com/killerrat/.dotfiles/tree/master/windows-terminal/"
    click F "https://github.com/killerrat/.dotfiles/tree/master/bashrc/"
    click G "https://github.com/killerrat/.dotfiles/tree/master/zshrc/"
    click H "https://github.com/killerrat/.dotfiles/tree/master/alacritty/"
    click I "https://github.com/killerrat/.dotfiles/tree/master/i3-manjaro/"
    click J "https://github.com/killerrat/.dotfiles/tree/master/nvim-lua/"
    click K "https://github.com/killerrat/.dotfiles/tree/master/dunst/"
    click L "https://github.com/killerrat/.dotfiles/tree/master/conky/"
    click M "https://github.com/killerrat/.dotfiles/tree/master/picom/"
    click N "https://github.com/killerrat/.dotfiles/tree/master/ranger/"
    click O "https://github.com/killerrat/.dotfiles/tree/master/yabai/"
    click P "https://github.com/killerrat/.dotfiles/tree/master/glazewm/"
    click Q "https://github.com/killerrat/.dotfiles/tree/master/nerd-dictation/"
    click R "https://github.com/killerrat/.dotfiles/tree/master/pacman/hooks/"
    click S "https://github.com/killerrat/.dotfiles/tree/master/nvim-docker/"
    click T "https://github.com/killerrat/.dotfiles/tree/master/lightdm/"
    click U "https://github.com/killerrat/.dotfiles/tree/master/skhd/"
    click V "https://github.com/killerrat/.dotfiles/tree/master/gitconfig/"
    click W "https://github.com/killerrat/.dotfiles/tree/master/ssh/"
    click X "https://github.com/killerrat/.dotfiles/tree/master/scripts/"
    click Y "https://github.com/killerrat/.dotfiles/tree/master/docs/"
```
