docs: modeline: Update commentary for performance optimizations

Add detailed explanations regarding performance optimizations in
Doom modeline settings. This includes prioritizing speed by
disabling minor features and tuning performance with specific
settings such as refresh rate and process output size.

1 files changed, 21 insertions, 1 deletions

diff --git a/modules/modeline-config.el b/modules/modeline-config.el
index 2e6ed6e61..0a247732a 100644
--- a/modules/modeline-config.el
+++ b/modules/modeline-config.el
@@ -3,6 +3,26 @@
 
 ;;; Commentary:
 
+;; Doom modeline configuration with performance optimizations.
+
+;; Settings prioritize speed while keeping essential information including:
+;; - relative file paths from project root
+;; - column number and percentage position
+;; - buffer modification indicators
+;; - and major mode with icon.
+
+;; Disabled features for performance:
+;; - minor modes display
+;; - word count
+;; - encoding info
+;; - LSP information
+
+;; Performance tuning includes:
+;; - 0.75 second refresh rate
+;; - 1MB process output chunks
+;; - nerd-icons (faster than all-the-icons)
+;; - simplified checker format
+;; - limited VCS info length
 
 ;;; Code:
 
@@ -47,9 +67,9 @@
   (doom-modeline-buffer-name t)             ;; Show buffer name
   (doom-modeline-buffer-file-name t)        ;; Show file name
   :config
+  (setq read-process-output-max (* 1024 1024)) ;; 1MB process read size for better performance
   (setq doom-modeline-refresh-rate 0.75))      ;; Update rate in seconds
 
-;; (setq read-process-output-max (* 1024 1024)) ;; 1MB process read size for better performance
 
 (provide 'modeline-config)
 ;;; modeline-config.el ends here