From 0791d74b0d219c70f977827d0d7c2998f2c76025 Mon Sep 17 00:00:00 2001
From: Ole-Morten Duesund <olemd@glemt.net>
Date: Fri, 6 Mar 2026 12:05:05 +0100
Subject: [PATCH] Add descriptive comments to all scripts

Each file now has a brief comment explaining what the tool is and
what the script does, aimed at someone with general Linux knowledge.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---
 10-bun-path             | 1 +
 10-go-path              | 1 +
 10-rust-path            | 1 +
 20-ninja                | 3 +++
 50-asdf-completion      | 1 +
 50-fj-completion        | 1 +
 50-tailscale-completion | 1 +
 99-android              | 2 ++
 99-claude.example       | 1 +
 99-gemini.example       | 1 +
 99-google.example       | 1 +
 99-huggingface.example  | 1 +
 99-replicate.example    | 1 +
 13 files changed, 16 insertions(+)

diff --git a/10-bun-path b/10-bun-path
index 006ab9d..f582a77 100755
--- a/10-bun-path
+++ b/10-bun-path
@@ -1,2 +1,3 @@
 # shellcheck shell=bash
+# Add Bun (a fast JavaScript runtime and package manager) to PATH
 path_append "$HOME/.bun/bin"
diff --git a/10-go-path b/10-go-path
index 6e4c1ed..3e4f316 100755
--- a/10-go-path
+++ b/10-go-path
@@ -1,3 +1,4 @@
 # shellcheck shell=bash
+# Set up Go workspace and add compiled Go binaries to PATH
 export GOPATH="$HOME/go"
 path_append "$GOPATH/bin"
diff --git a/10-rust-path b/10-rust-path
index 102068b..2d746c1 100755
--- a/10-rust-path
+++ b/10-rust-path
@@ -1,3 +1,4 @@
 # shellcheck shell=bash
+# Set up Rust/Cargo and add installed Rust binaries to PATH
 export CARGO_HOME="$HOME/.cargo"
 path_append "$CARGO_HOME/bin"
diff --git a/20-ninja b/20-ninja
index 2200658..5f82b3a 100755
--- a/20-ninja
+++ b/20-ninja
@@ -1,4 +1,7 @@
 # shellcheck shell=bash
+# Configure C/C++ build tools:
+# - Use Ninja instead of Make for CMake builds (faster parallel builds)
+# - Use ccache to cache compilations and speed up rebuilds
 if command -v ninja &>/dev/null; then
     export NINJA_STATUS="[%e sec | %p (%u remaining) | %o / sec] "
     export CMAKE_GENERATOR=Ninja
diff --git a/50-asdf-completion b/50-asdf-completion
index 99e080c..0e19688 100755
--- a/50-asdf-completion
+++ b/50-asdf-completion
@@ -1,3 +1,4 @@
 # shellcheck shell=bash
 # shellcheck disable=SC1090
+# Tab completion for asdf, a tool that manages multiple language runtime versions
 command -v asdf &>/dev/null && . <(asdf completion bash)
diff --git a/50-fj-completion b/50-fj-completion
index 60070b3..c2dd370 100755
--- a/50-fj-completion
+++ b/50-fj-completion
@@ -1,3 +1,4 @@
 # shellcheck shell=bash
 # shellcheck disable=SC1090
+# Tab completion for fj, the Forgejo CLI (like GitHub CLI but for Forgejo)
 command -v fj &>/dev/null && . <(fj completion bash)
diff --git a/50-tailscale-completion b/50-tailscale-completion
index 7469802..df8acec 100755
--- a/50-tailscale-completion
+++ b/50-tailscale-completion
@@ -1,3 +1,4 @@
 # shellcheck shell=bash
 # shellcheck disable=SC1090
+# Tab completion for Tailscale, a mesh VPN for connecting devices
 command -v tailscale &>/dev/null && . <(tailscale completion bash)
diff --git a/99-android b/99-android
index 29b04eb..7245d39 100755
--- a/99-android
+++ b/99-android
@@ -1,4 +1,6 @@
 # shellcheck shell=bash
+# Set up Android SDK and Java paths for Android development
+# Adds adb, fastboot, and SDK command-line tools to PATH
 if [[ -d "$HOME/android-sdk" ]]; then
     export ANDROID_HOME="$HOME/android-sdk"
     path_append "$ANDROID_HOME/cmdline-tools/latest/bin"
diff --git a/99-claude.example b/99-claude.example
index a17fdb5..f8bfa6b 100644
--- a/99-claude.example
+++ b/99-claude.example
@@ -1,4 +1,5 @@
 # shellcheck shell=bash
+# Forgejo API token used by Claude Code to read/write issues and PRs
 # Copy to 99-claude and fill in your token, then: chmod 700 99-claude
 require_private "${BASH_SOURCE[0]}"
 export FORGEJO_ISSUE_TOKEN_FOR_CLAUDE=your-token-here
diff --git a/99-gemini.example b/99-gemini.example
index 91fe52d..2cfe7fa 100644
--- a/99-gemini.example
+++ b/99-gemini.example
@@ -1,4 +1,5 @@
 # shellcheck shell=bash
+# API key for Google Gemini (generative AI)
 # Copy to 99-gemini and fill in your key, then: chmod 700 99-gemini
 require_private "${BASH_SOURCE[0]}"
 export GEMINI_API_KEY=your-key-here
diff --git a/99-google.example b/99-google.example
index 97f7840..b9d0655 100644
--- a/99-google.example
+++ b/99-google.example
@@ -1,4 +1,5 @@
 # shellcheck shell=bash
+# API key for Google Cloud services
 # Copy to 99-google and fill in your key, then: chmod 700 99-google
 require_private "${BASH_SOURCE[0]}"
 export GOOGLE_API_KEY=your-key-here
diff --git a/99-huggingface.example b/99-huggingface.example
index 1b2dbba..1587e57 100644
--- a/99-huggingface.example
+++ b/99-huggingface.example
@@ -1,4 +1,5 @@
 # shellcheck shell=bash
+# Access token for Hugging Face (ML model hub and inference API)
 # Copy to 99-huggingface and fill in your token, then: chmod 700 99-huggingface
 require_private "${BASH_SOURCE[0]}"
 export HF_TOKEN=your-token-here
diff --git a/99-replicate.example b/99-replicate.example
index 9dc9d0a..a152bcf 100644
--- a/99-replicate.example
+++ b/99-replicate.example
@@ -1,4 +1,5 @@
 # shellcheck shell=bash
+# API token for Replicate (cloud ML model hosting)
 # Copy to 99-replicate and fill in your token, then: chmod 700 99-replicate
 require_private "${BASH_SOURCE[0]}"
 export REPLICATE_API_TOKEN=your-token-here