From 4f24a47e1e8d5b325a57c9f5c1744f527cffc03b Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Tue, 10 Feb 2026 09:49:57 +0300
Subject: [PATCH] chore: update wording for example config comments

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: If5d8db30bc8b877e462a1a2d2fa5f6206a6a6964
---
 pinakes.example.toml | 50 +++++++++++++++++++++++---------------------
 1 file changed, 26 insertions(+), 24 deletions(-)

diff --git a/pinakes.example.toml b/pinakes.example.toml
index de4bf18..57c9e38 100644
--- a/pinakes.example.toml
+++ b/pinakes.example.toml
@@ -21,30 +21,30 @@ path = "pinakes.db"
 # database = "pinakes"
 # username = "pinakes"
 # password = "your_secure_password_here"
-# # Maximum number of database connections in the pool
+## Maximum number of database connections in the pool
 # max_connections = 10
-# # Enable TLS/SSL for database connections
-# # tls = { mode = "require", ca_cert = "/path/to/ca.pem" }
+## Enable TLS/SSL for database connections
+# tls = { mode = "require", ca_cert = "/path/to/ca.pem" }
 
 ## Directory Configuration
 [directories]
 # Root directories to scan for media files
 # Supports environment variable expansion: ${HOME}, $HOME
-# Paths can be absolute or relative to the working directory.
-# Add more directories as needed.
-
+# Paths can be absolute or relative to the working directory. Add more directories
+# as needed.
 roots = [
-    "${HOME}/Music",
-    "${HOME}/Documents",
-    "${HOME}/Videos",
-    "${HOME}/Pictures",
-    # ...
+  "${HOME}/Music",
+  "${HOME}/Documents",
+  "${HOME}/Videos",
+  "${HOME}/Pictures",
+  # ...
 ]
 
 ## File Scanning Configuration
 [scanning]
 # Watch directories for changes using filesystem events
 # When enabled, Pinakes will automatically detect new/modified/deleted files
+# and update the catalog index.
 # Default: true
 watch = true
 
@@ -56,16 +56,16 @@ poll_interval_secs = 300
 # File patterns to ignore during scanning (glob patterns)
 # Default: Hidden files and common build/cache directories
 ignore_patterns = [
-    ".*",              # Hidden files (starting with .)
-    "node_modules",    # JavaScript dependencies
-    "target",          # Rust build artifacts
-    ".git",            # Git repository data
-    "__pycache__",     # Python cache
-    "venv",            # Python virtual environments
-    "*.tmp",           # Temporary files
-    "*.swp",           # Vim swap files
-    "Thumbs.db",       # Windows thumbnail cache
-    ".DS_Store",       # macOS metadata
+  ".*",           # Hidden files (starting with .)
+  "node_modules", # JavaScript dependencies
+  "target",       # Rust build artifacts
+  ".git",         # Git repository data
+  "__pycache__",  # Python cache
+  "venv",         # Python virtual environments
+  "*.tmp",        # Temporary files
+  "*.swp",        # Vim swap files
+  "Thumbs.db",    # Windows thumbnail cache
+  ".DS_Store",    # macOS metadata
 ]
 
 ## Server Configuration
@@ -109,9 +109,9 @@ port = 3000
 ## Photo Management Configuration
 # These settings control CPU-intensive photo processing features
 [photos]
-# Generate perceptual hashes for image duplicate detection
-# Uses DCT (Discrete Cosine Transform) algorithm
-# CPU-intensive but enables finding visually similar images
+# Generate perceptual hashes for image duplicate detection. Uses the
+# DCT (Discrete Cosine Transform) algorithm, which is CPU-intensive, but
+# enables finding visually similar images (mostly) accurately.
 # Default: true
 generate_perceptual_hash = true
 
@@ -273,6 +273,8 @@ enabled = false
 # directory = "~/.local/share/pinakes/plugins"
 
 # Enable plugin system (experimental)
+# NOTE: The plugin system has not been finalized, and the API is subject to change.
+# Please report any bugs, and expect breaking changes.
 # Default: false
 # enabled = false