From 08e9404b4b591b1c8cf6c54852c3f5548e6fff48 Mon Sep 17 00:00:00 2001
From: amtoine <stevan.antoine@gmail.com>
Date: Sat, 19 Aug 2023 15:59:13 +0200
Subject: [PATCH] add comments to the default configuration

---
 examples/configuration/config.nuon      |  4 ++--
 examples/configuration/keybindings.nuon | 28 ++++++++++++-------------
 examples/configuration/themes/dark.nuon | 14 ++++++-------
 3 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/examples/configuration/config.nuon b/examples/configuration/config.nuon
index 46e6efb..b0f0289 100644
--- a/examples/configuration/config.nuon
+++ b/examples/configuration/config.nuon
@@ -1,4 +1,4 @@
 {
-    show_cell_path: true,
-    layout: "table",
+    show_cell_path: true,  # whether or not to show the current cell path above the status bar
+    layout: "table",  # the layout of the data, either "table" or "compact"
 }
diff --git a/examples/configuration/keybindings.nuon b/examples/configuration/keybindings.nuon
index 79b2262..e66f282 100644
--- a/examples/configuration/keybindings.nuon
+++ b/examples/configuration/keybindings.nuon
@@ -1,18 +1,18 @@
 {
-    quit: 'q',
-    insert: 'i',
-    normal: "escape",
-    navigation: {
-        left: 'h',
-        down: 'j',
-        up: 'k',
-        right: 'l',
+    quit: 'q',  # quit `explore`
+    insert: 'i',  # go to INSERT mode to modify the data
+    normal: "escape",  # go back to NORMAL mode to navigate through the data
+    navigation: {  # only in NORMAL mode
+        left: 'h',  # go back one level in the data
+        down: 'j',  # go one row down in the current level
+        up: 'k',  # go one row up in the current level
+        right: 'l',  # go one level deeper in the data or hit the bottom
     },
-    peek: 'p',
-    peeking: {
-        all: 'a',
-        current: 'c',
-        under: 'u',
-        quit: "escape",
+    peek: 'p',  # go to PEEKING mode to peek a value
+    peeking: {  # only in PEEKING mode
+        all: 'a',  # peek the whole data, from the top level
+        current: 'c',  # peek the current data, i.e. what is visible
+        under: 'u',  # peek only what's under the cursor
+        quit: "escape",  # go back to NORMAL mode to navigate through the data
     },
 }
diff --git a/examples/configuration/themes/dark.nuon b/examples/configuration/themes/dark.nuon
index fb3e835..54229b2 100644
--- a/examples/configuration/themes/dark.nuon
+++ b/examples/configuration/themes/dark.nuon
@@ -1,24 +1,24 @@
 {
-    normal: {
+    normal: {  # the colors for a normal row
         background: reset, # "black" is not pure *black*
         foreground: white,
     },
-    selected: {
+    selected: {  # the colors for the row under the cursor
         background: white,
         foreground: black,
     },
-    selected_modifier: "bold",
-    selected_symbol: "",
+    selected_modifier: "bold",  # a modifier to apply onto the row under the cursor
+    selected_symbol: "",  # the symbol to show to the left of the row under the cursor
     status_bar: {
-        normal: {
+        normal: {  # the colors for the status bar in NORMAL mode
             background: white,
             foreground: black,
         },
-        insert: {
+        insert: {  # the colors for the status bar in INSERT mode
             background: lightyellow,
             foreground: black,
         },
-        peek: {
+        peek: {  # the colors for the status bar in PEEKING mode
             background: lightgreen,
             foreground: black,
         }