How jacksonn97/dot-files works
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.”