# russmckendrick/dotfiles architecture

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

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

## Overview

##### Main Components

a) Configuration Management Layer
- Core dotfiles (.zshrc, .zprofile, .p10k.zsh, etc.)
- Git configuration (.gitconfig)
- Shell customization files

b) Asset Management Layer
- Static assets (assets directory)
- Backup system (backups directory)

c) Terminal Configuration Layer
- iTerm2 specific configurations (iterm2_profile directory)
- Terminal appearance and behavior settings

d) Utility Layer
- Maintenance scripts (clean_zsh_history.sh)
- Installation and setup processes

**┌─────────────────────────────────────────────┐**
- User Environment               │
- ┘
- ↑
**┌─────────────────────────────────────────────┐**
- Configuration Management Layer       │
- ┬─────────────┬────────────────┤
- Shell      │   Git       │  Terminal      │
- Config     │   Config    │  Config        │
- (.zshrc)   │ (.gitconfig)│  (iTerm2)      │
- ┴─────────────┴────────────────┘
- ↑
**┌─────────────────────────────────────────────┐**
- Support Layer                   │
- ┬─────────────┬────────────────┤
- Assets     │  Backups    │  Utilities     │
- Directory  │  System     │  Scripts       │
- ┴─────────────┴────────────────┘

##### Important Elements to Highlight

a) Configuration Flow:
- How dotfiles are symlinked into the user's home directory
- Backup processes and their frequency
- Relationship between different configuration files

b) Integration Points:
- How iTerm2 profiles are loaded
- Where custom scripts integrate with the shell environment
- Interaction points with version control

##### Metadata

- Version information
- Dependencies (like zsh, iTerm2)
- Required system components
- Installation prerequisites

Remember to:
- Use clear, consistent naming
- Brief descriptions for each major component
- Flow of configuration loading
- Where user customizations typically occur

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph User["User Environment"]
        Home[("Home Directory")]
    end

    subgraph Config["Configuration Management Layer"]
        Shell["Shell Configuration"]
        Git["Git Configuration"]
        Term["Terminal Configuration"]
    end

    subgraph Support["Support Layer"]
        Assets["Asset Management"]
        Backup["Backup System"]
        Utils["Utility Scripts"]
    end

    %% Shell Configuration Details
    subgraph ShellConfig["Shell Configuration Details"]
        Zshrc[".zshrc"]
        Zprofile[".zprofile"]
        P10k[".p10k.zsh"]
        Hush[".hushlogin"]
    end

    %% Git Configuration Details
    subgraph GitConfig["Git Configuration Details"]
        Gitconfig[".gitconfig"]
        GitIgnore[".gitignore"]
    end

    %% Terminal Configuration Details
    subgraph TermConfig["Terminal Configuration Details"]
        ITermProf["iTerm2 Profile"]
        ITermPlist["iTerm2 Plist"]
        ITermSupport["App Support"]
    end

    %% Support Layer Details
    subgraph SupportDetails["Support Components"]
        AssetFiles["Static Assets"]
        BackupSystem["Backup Directory"]
        CleanScript["History Cleaner"]
    end

    %% Relationships
    Home --> Shell
    Home --> Git
    Home --> Term
    
    Shell --> ShellConfig
    Git --> GitConfig
    Term --> TermConfig
    
    Shell --> Support
    Git --> Support
    Term --> Support

    %% Click Events
    click Zshrc "https://github.com/russmckendrick/dotfiles/blob/main/.zshrc"
    click Zprofile "https://github.com/russmckendrick/dotfiles/blob/main/.zprofile"
    click P10k "https://github.com/russmckendrick/dotfiles/blob/main/.p10k.zsh"
    click Hush "https://github.com/russmckendrick/dotfiles/blob/main/.hushlogin"
    click Gitconfig "https://github.com/russmckendrick/dotfiles/blob/main/.gitconfig"
    click GitIgnore "https://github.com/russmckendrick/dotfiles/blob/main/.gitignore"
    click ITermProf "https://github.com/russmckendrick/dotfiles/tree/main/iterm2_profile"
    click ITermPlist "https://github.com/russmckendrick/dotfiles/blob/main/iterm2_profile/com.googlecode.iterm2.plist"
    click ITermSupport "https://github.com/russmckendrick/dotfiles/tree/main/iterm2_profile/AppSupport"
    click AssetFiles "https://github.com/russmckendrick/dotfiles/tree/main/assets"
    click BackupSystem "https://github.com/russmckendrick/dotfiles/tree/main/backups"
    click CleanScript "https://github.com/russmckendrick/dotfiles/blob/main/clean_zsh_history.sh"

    %% Styling
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px
    classDef config fill:#d4e6f1,stroke:#2874a6
    classDef support fill:#d5f5e3,stroke:#196f3d
    classDef utility fill:#fad7a0,stroke:#b9770e
    
    class Shell,Git,Term config
    class Assets,Backup,Utils support
    class CleanScript utility

    %% Legend
    subgraph Legend
        ConfigL["Configuration Component"]:::config
        SupportL["Support Component"]:::support
        UtilityL["Utility Component"]:::utility
    end
```
