# yedhink/dotfiles_ikigai architecture

> Architecture diagram of the GitHub repository yedhink/dotfiles_ikigai, 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/yedhink/dotfiles_ikigai
- Repository: https://github.com/yedhink/dotfiles_ikigai

## Overview

##### Main Components
- Shell Configurations – Notice that you have substantial configuration for two shells: primarily Fish (with distinct folders for completions, functions, and various utility scripts) and also Zsh. Create a “Shell Environment” node that further splits into two: one for Fish (emphasizing autocompletion, alias functions, etc.) and one for Zsh.
- Terminal Emulators – You’re using Ghostty (described for its fast startup and lean memory consumption) and there’s a wezterm configuration as well. Represent a “Terminal Emulator” node that feeds into the shell environment.
- Editor and Multiplexing – Neovim is extensively configured (with a “custom” folder for plugins), and there’s a tmux configuration file. Create a combined “Editor & Workspace” component where Neovim connects to a “Terminal Multiplexer” subcomponent. Indicate integration such as session restoration and dedicated tmux windows.
- File Managers – There are dedicated configurations for both Ranger and Yazi (with Yazi integrated as a file manager inside Neovim). A “File Management” component should include these tools.
- Additional Tools & Scripts – Include a node for various utility scripts (found in the scripts directory) as well as package management definitions (Brewfile and gemlist) that capture development environment provisioning.
- Legacy/Old Configs – The “old_linux_dots” directory illustrates how configurations evolved, so you might want to note this as a reference for legacy practices or fallback setups.

##### Relationships and Interactions
- The “Editor & Workspace” component (Neovim + tmux) should be linked to both the shell and file managers (Ranger and Yazi) demonstrating integration.
- The utility scripts and package management nodes feed into the overall configuration management, showing how they are used to install or update various components.
- Indicating the integration of plugins within Neovim as a sub-layer, emphasizing that many plugins enhance file navigation (fzf, lazygit, treesitter, etc.).

##### Architectural Patterns and Design Principles
- Modularity and Separation of Concerns – Each tool (shell, terminal emulator, editor, file manager) is configured separately. Capturing each in its own module and outlining their points of integration highlights this modular design.
- Customization and Extensibility – The repository does not rely on an external dotfile manager but rather leverages Git and scripts for management. This can be noted as “self‑contained configuration management.”
- Performance Emphasis – The README stresses speed and low latency (e.g., Ghostty’s fast prompt display and neovim’s session restoration), so you might include annotations for performance-sensitive interactions.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Terminal Emulator Subgraph
    subgraph "Terminal Emulator"
        ghosttyTerm["Ghostty Terminal"]:::terminal
        weztermTerm["Wezterm Terminal"]:::terminal
    end

    %% Shell Environment Subgraph
    subgraph "Shell Environment"
        fishConfig["Fish Shell Config"]:::shell
        zshConfig["Zsh Config"]:::shell
    end

    %% Editor & Workspace Subgraph
    subgraph "Editor & Workspace"
        nvimConfig["Neovim + Plugins"]:::editor
        tmuxConfig["tmux Config"]:::editor
    end

    %% File Management Subgraph
    subgraph "File Management"
        rangerFM["Ranger"]:::filem
        yaziFM["Yazi"]:::filem
    end

    %% Additional Tools & Scripts Subgraph
    subgraph "Additional Tools & Scripts"
        utils["Utility Scripts"]:::script
        legacyUtils["Legacy Utility Scripts"]:::script
        brewfile["Brewfile"]:::script
        gemlist["Gemlist"]:::script
    end

    %% Legacy/Old Configs Subgraph
    subgraph "Legacy/Old Configs"
        legacy["Legacy/Old Configs"]:::legacy
    end

    %% Config Manager Node (Aggregates configuration management)
    configManager["Config Manager"]:::manager

    %% Main Flow Connections
    %% Terminal launches Shell Environment
    ghosttyTerm -->|"launches"| fishConfig
    weztermTerm -->|"launches"| fishConfig

    %% Shell Environment starts Editor & Workspace
    fishConfig -->|"starts"| nvimConfig
    zshConfig -->|"starts"| tmuxConfig

    %% Editor & Workspace integrates with File Management
    nvimConfig -->|"integrates"| rangerFM
    nvimConfig -->|"integrates"| yaziFM

    %% Config Manager manages overall configuration across components
    configManager ---|"manages"| ghosttyTerm
    configManager ---|"manages"| fishConfig
    configManager ---|"manages"| nvimConfig
    configManager ---|"manages"| rangerFM

    %% Additional Tools & Scripts feed into configuration management
    utils ---|"feeds"| configManager
    brewfile ---|"feeds"| configManager
    gemlist ---|"feeds"| configManager
    legacyUtils ---|"feeds"| configManager

    %% Legacy configurations reference configuration management
    legacy ---|"references"| configManager

    %% Class Definitions
    classDef shell fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef terminal fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef editor fill:#DDA0DD,stroke:#000,stroke-width:2px;
    classDef filem fill:#FFA07A,stroke:#000,stroke-width:2px;
    classDef script fill:#F0E68C,stroke:#000,stroke-width:2px;
    classDef legacy fill:#D3D3D3,stroke:#000,stroke-width:2px;
    classDef manager fill:#FFB6C1,stroke:#000,stroke-width:2px;

    %% Click Events
    click fishConfig "https://github.com/yedhink/dotfiles_ikigai/tree/main/.config/fish"
    click zshConfig "https://github.com/yedhink/dotfiles_ikigai/tree/main/zsh"
    click ghosttyTerm "https://github.com/yedhink/dotfiles_ikigai/tree/main/.config/ghostty"
    click weztermTerm "https://github.com/yedhink/dotfiles_ikigai/tree/main/.config/wezterm"
    click nvimConfig "https://github.com/yedhink/dotfiles_ikigai/tree/main/.config/nvim"
    click tmuxConfig "https://github.com/yedhink/dotfiles_ikigai/blob/main/.tmux.conf"
    click rangerFM "https://github.com/yedhink/dotfiles_ikigai/tree/main/.config/ranger"
    click yaziFM "https://github.com/yedhink/dotfiles_ikigai/tree/main/.config/yazi"
    click utils "https://github.com/yedhink/dotfiles_ikigai/tree/main/scripts"
    click legacyUtils "https://github.com/yedhink/dotfiles_ikigai/tree/main/old_linux_dots/scripts"
    click brewfile "https://github.com/yedhink/dotfiles_ikigai/tree/main/Brewfile"
    click gemlist "https://github.com/yedhink/dotfiles_ikigai/blob/main/.gemlist"
    click legacy "https://github.com/yedhink/dotfiles_ikigai/tree/main/old_linux_dots"
```
