✨ Add description fields to configuration

changelog.md

@@ -614,4 +614,13 @@ Added Sprig template functions to enhance template capabilities:
 - Added full set of Sprig text template functions
 - Available in both file templates and config templates
 - Includes string manipulation, math, date formatting, and more
-- Removed custom add function in favor of Sprig's math functions
+- Removed custom add function in favor of Sprig's math functions
+
+# Added Configuration Descriptions
+
+Added description fields to improve configuration documentation:
+
+- Added top-level description field to describe the overall configuration purpose
+- Added per-selector description field to document each selector's purpose
+- Updated example configurations with detailed descriptions
+- Improved self-documentation of configuration files

cmd/tools/test-html-selector/main.go

@@ -20,19 +20,21 @@ import (
 )
 
 type Config struct {
-	File      string     `yaml:"file"`
-	Selectors []Selector `yaml:"selectors"`
-	Config    struct {
+	File        string     `yaml:"file"`
+	Description string     `yaml:"description"`
+	Selectors   []Selector `yaml:"selectors"`
+	Config      struct {
 		SampleCount  int    `yaml:"sample_count"`
 		ContextChars int    `yaml:"context_chars"`
 		Template     string `yaml:"template"`
 	} `yaml:"config"`
 }
 
 type Selector struct {
-	Name     string `yaml:"name"`
-	Selector string `yaml:"selector"`
-	Type     string `yaml:"type"` // "css" or "xpath"
+	Name        string `yaml:"name"`
+	Selector    string `yaml:"selector"`
+	Type        string `yaml:"type"` // "css" or "xpath"
+	Description string `yaml:"description"`
 }
 
 type SimplifiedSample struct {