From 93f59b9fffd4cdd7b29813b6eb06f4d1e6475156 Mon Sep 17 00:00:00 2001
From: Arpit Chakladar <arpitchakladar@proton.me>
Date: Sat, 11 Apr 2026 00:19:11 +0530
Subject: Added more documentation comments

---
 modules/scripts/deep-clean.sh       | 3 +++
 modules/scripts/default.nix         | 1 +
 modules/scripts/screen-recording.sh | 4 ++++
 modules/scripts/system-monitor.sh   | 4 ++++
 4 files changed, 12 insertions(+)

(limited to 'modules/scripts')

diff --git a/modules/scripts/deep-clean.sh b/modules/scripts/deep-clean.sh
index dcbd62b..5d1c87a 100644
--- a/modules/scripts/deep-clean.sh
+++ b/modules/scripts/deep-clean.sh
@@ -1,3 +1,6 @@
+# Deep clean script for Nix systems
+# Removes old generations, garbage, and optimizes store
+# WARNING: Do NOT run with sudo - run as normal user
 echo "--- Starting Nix Deep Clean ---"
 
 if [[ $EUID -eq 0 ]]; then
diff --git a/modules/scripts/default.nix b/modules/scripts/default.nix
index ca555c7..3fea3df 100644
--- a/modules/scripts/default.nix
+++ b/modules/scripts/default.nix
@@ -4,6 +4,7 @@
   ...
 }:
 
+# Scripts - Home directory shell scripts (deep-clean, screen-recording, system-monitor)
 {
   config = {
     home.sessionPath = [
diff --git a/modules/scripts/screen-recording.sh b/modules/scripts/screen-recording.sh
index a3bf86a..c0e8525 100644
--- a/modules/scripts/screen-recording.sh
+++ b/modules/scripts/screen-recording.sh
@@ -1,3 +1,7 @@
+# Screen recording script using FFmpeg and slop for region selection
+# Records X11 screen to MP4 with x264 encoding
+# Usage: screen-recording.sh [-s|--select]
+#   -s, --select  Launch slop to select recording region
 OUT_DIR="$HOME/Videos/Recordings"
 mkdir -p "$OUT_DIR"
 
diff --git a/modules/scripts/system-monitor.sh b/modules/scripts/system-monitor.sh
index 951428c..cadae3a 100644
--- a/modules/scripts/system-monitor.sh
+++ b/modules/scripts/system-monitor.sh
@@ -1,3 +1,7 @@
+# System monitor script using tmux to run bottom and nvtop side-by-side
+# Opens a tmux session with:
+#   - Left pane: bottom (system/process monitor)
+#   - Right pane: nvtop (GPU monitor)
 SESSION="system-monitor"
 
 kitty @ set-font-size -- -4
-- 
cgit v1.2.3