# jacksonn97/dot-files architecture

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

- Interactive diagram: https://gitdiagram.com/jacksonn97/dot-files
- Repository: https://github.com/jacksonn97/dot-files

## Overview

##### Project type and purpose
- This is a “dot-files” or configuration-management repository. Its sole purpose is to store and version your personal configuration for tools like zsh, kitty, nvim, sway, ranger, waybar, and fuzzel.

##### File structure
- Top-level files:
- .gitignore – standard git exclusions
- .zshrc – shell configuration for zsh
- README.md – clone instructions
- Top-level directories (each corresponds to a tool and will be symlinked or copied to ~/.config):
- fuzzel/ (fuzzel.ini)
- kitty/ (kitty.conf & Gruvbox Dark.conf)
- nvim/ (init.vim)
- ranger/ (rc.conf)
- sway/ (config)
- waybar/ (config & style.css)

##### README for additional insights
- The only instruction is to clone this repo into ~/.config. From that point, each application will automatically pick up its config from the matching subdirectory.

##### Components
a. Main components:
– GitHub dot-files repo (origin)
– Local clone in ~/.config/dot-files
– Shell (zsh) reading ~/.zshrc
– Applications reading their configs from ~/.config/<tool>
b. Relationships and interactions:
– At boot/login: zsh loads ~/.zshrc
– Each GUI or TUI app (kitty, nvim, ranger, sway, waybar, fuzzel) reads its config file from the cloned repo’s subdirectory
– The user can update configs locally and push back to GitHub
c. Architectural patterns/design principles:
– Single source of truth: all configs live under version control
– Separation of concerns: each tool has its own config directory
– Declarative configuration: no generated files—everything is explicit
d. Relevant technologies/frameworks:
– git (for version control)
– zsh shell
– kitty terminal emulator
– neovim
– ranger file manager
– sway window manager
– waybar status bar
– fuzzel quick-launcher

##### Elements
– Clear labels: “GitHub Repo,” “Local ~/.config/dot-files,” each application name
- from GitHub to Local clone (git clone)
- from Local clone to each application (config load)
- from Local clone back to GitHub (git push/pull)
- Green ovals for applications
- A central “Operating System / Filesystem” boundary

Recommended Layout:
- Enclose all of the above in a faint rectangle labeled “User’s Linux Desktop Environment.”

## Diagram (Mermaid)

```mermaid
flowchart TD
    GH["GitHub: dot-files repo"]:::repo
    LC["Local ~/.config/dot-files"]:::repo
    GH <--> LC

    subgraph "User's Linux Desktop Environment"
        direction TB
        LC --> GITIG
        LC --> README
        LC --> ZSH
        LC --> FUZ_DIR
        LC --> KIT_DIR
        LC --> NVIM_DIR
        LC --> RANGER_DIR
        LC --> SWAY_DIR
        LC --> WAYBAR_DIR

        GITIG[".gitignore"]:::repo
        README["README.md"]:::repo
        ZSH[".zshrc"]:::repo

        subgraph "fuzzel/"
            direction TB
            FUZ_C["fuzzel.ini"]:::repo
        end
        FUZ_DIR["fuzzel/"]:::repo
        FUZ_DIR --> FUZ_C
        FUZ_C -->|"reads"| FUZ["Fuzzel"]:::app

        subgraph "kitty/"
            direction TB
            KC["kitty.conf"]:::repo
            KG["Gruvbox Dark.conf"]:::repo
        end
        KIT_DIR["kitty/"]:::repo
        KIT_DIR --> KC
        KIT_DIR --> KG
        KC -->|"reads"| KTTY["Kitty"]:::app
        KG -->|"reads"| KTTY

        subgraph "nvim/"
            NVFILE["init.vim"]:::repo
        end
        NVIM_DIR["nvim/"]:::repo
        NVIM_DIR --> NVFILE
        NVFILE -->|"reads"| VIM["Neovim"]:::app

        subgraph "ranger/"
            RFILE["rc.conf"]:::repo
        end
        RANGER_DIR["ranger/"]:::repo
        RANGER_DIR --> RFILE
        RFILE -->|"reads"| RGR["Ranger"]:::app

        subgraph "sway/"
            SFILE["config"]:::repo
        end
        SWAY_DIR["sway/"]:::repo
        SWAY_DIR --> SFILE
        SFILE -->|"reads"| SW["Sway"]:::app

        subgraph "waybar/"
            WCONF["config"]:::repo
            WSTYLE["style.css"]:::repo
        end
        WAYBAR_DIR["waybar/"]:::repo
        WAYBAR_DIR --> WCONF
        WAYBAR_DIR --> WSTYLE
        WCONF -->|"reads"| WB["Waybar"]:::app
        WSTYLE --> WB
    end

    ZSH -->|"loads"| SH["Zsh Shell"]:::app

    click LC "https://github.com/jacksonn97/dot-files/blob/master/."
    click ZSH "https://github.com/jacksonn97/dot-files/blob/master/.zshrc"
    click GITIG "https://github.com/jacksonn97/dot-files/blob/master/.gitignore"
    click README "https://github.com/jacksonn97/dot-files/blob/master/README.md"
    click KC "https://github.com/jacksonn97/dot-files/blob/master/kitty/kitty.conf"
    click KG "https://github.com/jacksonn97/dot-files/blob/master/kitty/Gruvbox Dark.conf"
    click NVFILE "https://github.com/jacksonn97/dot-files/blob/master/nvim/init.vim"
    click RFILE "https://github.com/jacksonn97/dot-files/blob/master/ranger/rc.conf"
    click SFILE "https://github.com/jacksonn97/dot-files/tree/master/sway/config"
    click WCONF "https://github.com/jacksonn97/dot-files/tree/master/waybar/config"
    click WSTYLE "https://github.com/jacksonn97/dot-files/blob/master/waybar/style.css"
    click FUZ_C "https://github.com/jacksonn97/dot-files/blob/master/fuzzel/fuzzel.ini"

    classDef repo fill:#D6EFFF,stroke:#0366d6
    classDef app fill:#D2F8D2,stroke:#28a745
```
