# flaviogf/dotfiles architecture

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

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

## Overview

##### Project type and purpose
- This is a personal “dotfiles” repository. Its purpose is to store and version‐control the user’s configuration files for various command-line tools and GUI applications (fish shell, i3 window manager, Neovim, Starship prompt, WezTerm terminal, X11, etc.).
- The README confirms that it is simply a central place for all the user’s dotfiles with an MIT license.

##### File structure
- Top‐level files:
- .gitconfig – Git configuration
- .xinitrc – X11 startup script
- LICENSE – license text
- README.org – project description
- Top‐level directory .config holds subfolders for each application:
- fish/ (fish shell)
- i3/ (i3 window manager)
- nvim/ (Neovim, including Lua modules and plugin setup)
- starship.toml (prompt config)
- wezterm/ (WezTerm terminal)
- Notice the XDG pattern: everything under ~/.config.
- No build scripts or deployment manifests—syncing is done via Git and symlinks.

##### README for additional insights
- The README only states “save all my dotfiles” and points to the LICENSE.

##### Detailed separation of components
- Version Control Layer: GitHub (or other), local .git directory
- Deployment Layer: bootstrap script or manual symlinking
- Configuration Layer:
- ~/.config/fish/config.fish
- ~/.config/i3/config
- ~/.config/nvim/init.lua + lua/ modules
- ~/.config/starship.toml
- ~/.config/wezterm/wezterm.lua
- ~/.xinitrc
- Runtime Layer: fish shell, i3 window manager, Neovim editor, Starship prompt, WezTerm terminal

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Version Control Layer
    subgraph "Version Control Layer"
        direction TB
        GitRemote["Git Remote"]:::versioncontrol
        LocalRepo["Local Repo (/)"]:::versioncontrol
        GitConfig[".gitconfig"]:::versioncontrol
        XInit[".xinitrc"]:::versioncontrol
        License["LICENSE"]:::versioncontrol
        Readme["README.org"]:::versioncontrol
    end

    %% Deployment Layer
    subgraph "Deployment Layer"
        direction TB
        Installer["Symlink Installer"]:::deployment
    end

    %% Configuration Layer
    subgraph "Configuration Layer"
        direction TB
        FishConfig["~/.config/fish/config.fish"]:::config
        i3Config["~/.config/i3/config"]:::config
        NVIMInit["~/.config/nvim/init.lua"]:::config
        NVIMModules["~/.config/nvim/lua/config/"]:::config
        NVIMPlugins["~/.config/nvim/lua/plugins/disabled.lua"]:::config
        StyluaConfig["~/.config/nvim/stylua.toml"]:::config
        NeoconfConfig["~/.config/nvim/.neoconf.json"]:::config
        StarshipConfig["~/.config/starship.toml"]:::config
        WeztermConfig["~/.config/wezterm/wezterm.lua"]:::config
    end

    %% Runtime Layer
    subgraph "Runtime Layer"
        direction TB
        FishShell["Fish Shell"]:::runtime
        I3WM["i3 Window Manager"]:::runtime
        Neovim["Neovim Editor"]:::runtime
        StarshipPrompt["Starship Prompt"]:::runtime
        WezTerm["WezTerm Terminal"]:::runtime
        X11["X11 (via .xinitrc)"]:::runtime
    end

    %% Connections
    GitRemote -->|"clone/pull"| LocalRepo
    LocalRepo --> Installer
    Installer --> FishConfig
    Installer --> i3Config
    Installer --> NVIMInit
    Installer --> NVIMModules
    Installer --> NVIMPlugins
    Installer --> StyluaConfig
    Installer --> NeoconfConfig
    Installer --> StarshipConfig
    Installer --> WeztermConfig
    Installer --> XInit

    FishConfig -->|"reads config"| FishShell
    i3Config -->|"reads config"| I3WM
    NVIMInit -->|"reads init"| Neovim
    NVIMModules -->|"loads modules"| Neovim
    NVIMPlugins -->|"loads plugins"| Neovim
    StyluaConfig -->|"formatter config"| Neovim
    NeoconfConfig -->|"metadata"| Neovim
    StarshipConfig -->|"reads config"| StarshipPrompt
    WeztermConfig -->|"reads config"| WezTerm
    XInit -->|"startup script"| X11

    %% Click Events
    click LocalRepo "https://github.com/flaviogf/dotfiles/tree/master//"
    click GitConfig "https://github.com/flaviogf/dotfiles/blob/master//.gitconfig"
    click XInit "https://github.com/flaviogf/dotfiles/blob/master//.xinitrc"
    click License "https://github.com/flaviogf/dotfiles/tree/master//LICENSE"
    click Readme "https://github.com/flaviogf/dotfiles/blob/master//README.org"
    click FishConfig "https://github.com/flaviogf/dotfiles/blob/master//.config/fish/config.fish"
    click i3Config "https://github.com/flaviogf/dotfiles/tree/master//.config/i3/config"
    click NVIMInit "https://github.com/flaviogf/dotfiles/blob/master//.config/nvim/init.lua"
    click NVIMModules "https://github.com/flaviogf/dotfiles/tree/master//.config/nvim/lua/config/"
    click NVIMPlugins "https://github.com/flaviogf/dotfiles/blob/master//.config/nvim/lua/plugins/disabled.lua"
    click StyluaConfig "https://github.com/flaviogf/dotfiles/blob/master//.config/nvim/stylua.toml"
    click NeoconfConfig "https://github.com/flaviogf/dotfiles/blob/master//.config/nvim/.neoconf.json"
    click StarshipConfig "https://github.com/flaviogf/dotfiles/blob/master//.config/starship.toml"
    click WeztermConfig "https://github.com/flaviogf/dotfiles/blob/master//.config/wezterm/wezterm.lua"

    %% Styles
    classDef versioncontrol fill:#f9f,stroke:#333,stroke-width:1px
    classDef deployment fill:#ff9,stroke:#333,stroke-width:1px
    classDef config fill:#9ff,stroke:#333,stroke-width:1px
    classDef runtime fill:#dfd,stroke:#333,stroke-width:1px
```
