From faa7786979044dd19c3d64879dbddae25dfee46d Mon Sep 17 00:00:00 2001
From: LGUG2Z <LGUG2Z@fastmail.com>
Date: Sat, 13 Jul 2024 14:40:43 -0700
Subject: [PATCH] docs(mkdocs): add updates for v0.1.28 features

---
 README.md                               |   2 +-
 docs/cli/ahk-library.md                 |  12 ---
 docs/cli/border-implementation.md       |  20 ++++
 docs/cli/border-style.md                |  21 ++++
 docs/cli/clear-all-workspace-rules.md   |  12 +++
 docs/cli/clear-named-workspace-rules.md |  16 +++
 docs/cli/clear-workspace-rules.md       |  19 ++++
 docs/cli/window-hiding-behaviour.md     |   2 +-
 docs/common-workflows/animations.md     |  25 +++++
 docs/komorebi.example.json              |   2 +-
 mkdocs.yml                              |   6 ++
 schema.json                             | 130 ++++++++++++++++++++++--
 12 files changed, 242 insertions(+), 25 deletions(-)
 delete mode 100644 docs/cli/ahk-library.md
 create mode 100644 docs/cli/border-implementation.md
 create mode 100644 docs/cli/border-style.md
 create mode 100644 docs/cli/clear-all-workspace-rules.md
 create mode 100644 docs/cli/clear-named-workspace-rules.md
 create mode 100644 docs/cli/clear-workspace-rules.md
 create mode 100644 docs/common-workflows/animations.md

diff --git a/README.md b/README.md
index df6379c5..3e64de64 100644
--- a/README.md
+++ b/README.md
@@ -358,7 +358,7 @@ every `WindowManagerEvent` and `SocketMessage` handled by `komorebi` in a Rust c
 Below is a simple example of how to use `komorebi-client` in a basic Rust application.
 
 ```rust
-// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.25"}
+// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.28"}
 
 use anyhow::Result;
 use komorebi_client::Notification;
diff --git a/docs/cli/ahk-library.md b/docs/cli/ahk-library.md
deleted file mode 100644
index bae05042..00000000
--- a/docs/cli/ahk-library.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# ahk-library
-
-```
-Generate a library of AutoHotKey helper functions
-
-Usage: komorebic.exe komorebic.exe ahk-library
-
-Options:
-  -h, --help
-          Print help
-
-```
diff --git a/docs/cli/border-implementation.md b/docs/cli/border-implementation.md
new file mode 100644
index 00000000..3f955bab
--- /dev/null
+++ b/docs/cli/border-implementation.md
@@ -0,0 +1,20 @@
+# border-implementation
+
+```
+Set the border implementation
+
+Usage: komorebic.exe border-implementation <STYLE>
+
+Arguments:
+  <STYLE>
+          Desired border implementation
+
+          Possible values:
+          - komorebi: Use the adjustable komorebi border implementation
+          - windows:  Use the thin Windows accent border implementation
+
+Options:
+  -h, --help
+          Print help (see a summary with '-h')
+
+```
diff --git a/docs/cli/border-style.md b/docs/cli/border-style.md
new file mode 100644
index 00000000..07c18a25
--- /dev/null
+++ b/docs/cli/border-style.md
@@ -0,0 +1,21 @@
+# border-style
+
+```
+Set the border style
+
+Usage: komorebic.exe border-style <STYLE>
+
+Arguments:
+  <STYLE>
+          Desired border style
+
+          Possible values:
+          - system:  Use the system border style
+          - rounded: Use the Windows 11-style rounded borders
+          - square:  Use the Windows 10-style square borders
+
+Options:
+  -h, --help
+          Print help (see a summary with '-h')
+
+```
diff --git a/docs/cli/clear-all-workspace-rules.md b/docs/cli/clear-all-workspace-rules.md
new file mode 100644
index 00000000..8a90c59f
--- /dev/null
+++ b/docs/cli/clear-all-workspace-rules.md
@@ -0,0 +1,12 @@
+# clear-all-workspace-rules
+
+```
+Remove all application association rules for all workspaces
+
+Usage: komorebic.exe clear-all-workspace-rules
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/clear-named-workspace-rules.md b/docs/cli/clear-named-workspace-rules.md
new file mode 100644
index 00000000..14f38a4b
--- /dev/null
+++ b/docs/cli/clear-named-workspace-rules.md
@@ -0,0 +1,16 @@
+# clear-named-workspace-rules
+
+```
+Remove all application association rules for a named workspace
+
+Usage: komorebic.exe clear-named-workspace-rules <WORKSPACE>
+
+Arguments:
+  <WORKSPACE>
+          Name of a workspace
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/clear-workspace-rules.md b/docs/cli/clear-workspace-rules.md
new file mode 100644
index 00000000..fb623605
--- /dev/null
+++ b/docs/cli/clear-workspace-rules.md
@@ -0,0 +1,19 @@
+# clear-workspace-rules
+
+```
+Remove all application association rules for a workspace by monitor and workspace index
+
+Usage: komorebic.exe clear-workspace-rules <MONITOR> <WORKSPACE>
+
+Arguments:
+  <MONITOR>
+          Monitor index (zero-indexed)
+
+  <WORKSPACE>
+          Workspace index on the specified monitor (zero-indexed)
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/window-hiding-behaviour.md b/docs/cli/window-hiding-behaviour.md
index 8071dae3..4ffc09ec 100644
--- a/docs/cli/window-hiding-behaviour.md
+++ b/docs/cli/window-hiding-behaviour.md
@@ -10,7 +10,7 @@ Arguments:
           Possible values:
           - hide:     Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)
           - minimize: Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)
-          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces (has foregrounding issues)
+          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces
 
 Options:
   -h, --help
diff --git a/docs/common-workflows/animations.md b/docs/common-workflows/animations.md
new file mode 100644
index 00000000..ea2fc5e9
--- /dev/null
+++ b/docs/common-workflows/animations.md
@@ -0,0 +1,25 @@
+# Animations
+
+If you would like to add window movement animations, ensure the following options are
+defined in the `komorebi.json` configuration file.
+
+```json
+{
+  "animation": {
+    "enabled": true
+  }
+}
+```
+
+Window movement animations only apply to actions taking place within the same monitor
+workspace.
+
+You can optionally set a custom duration in ms with `animation.duration` (default: `250`),
+a custom style with `animation.style` (default: `Linear`), and a custom FPS value with
+`animation.fps` (default: `60`).
+
+It is important to note that higher `fps` and a longer `duration` settings will result
+in increased CPU usage.
+
+This feature is not considered stable, and you may encounter visual artifacts
+from time to time.
\ No newline at end of file
diff --git a/docs/komorebi.example.json b/docs/komorebi.example.json
index cec8c369..c7329af6 100644
--- a/docs/komorebi.example.json
+++ b/docs/komorebi.example.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.25/schema.json",
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.28/schema.json",
   "app_specific_configuration_path": "$Env:USERPROFILE/applications.yaml",
   "window_hiding_behaviour": "Cloak",
   "cross_monitor_move_behaviour": "Insert",
diff --git a/mkdocs.yml b/mkdocs.yml
index 6d9832d8..a1741cd1 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -57,6 +57,7 @@ nav:
       - Troubleshooting: troubleshooting.md
   - Common workflows:
       - common-workflows/komorebi-config-home.md
+      - common-workflows/animations.md
       - common-workflows/autohotkey.md
       - common-workflows/borders.md
       - common-workflows/stackbar.md
@@ -191,6 +192,9 @@ nav:
       - cli/initial-named-workspace-rule.md
       - cli/workspace-rule.md
       - cli/named-workspace-rule.md
+      - cli/clear-workspace-rules.md
+      - cli/clear-named-workspace-rules.md
+      - cli/clear-all-workspace-rules.md
       - cli/identify-object-name-change-application.md
       - cli/identify-tray-application.md
       - cli/identify-layered-application.md
@@ -200,6 +204,8 @@ nav:
       - cli/border-colour.md
       - cli/border-width.md
       - cli/border-offset.md
+      - cli/border-style.md
+      - cli/border-implementation.md
       - cli/transparency.md
       - cli/transparency-alpha.md
       - cli/focus-follows-mouse.md
diff --git a/schema.json b/schema.json
index 3259f5de..9c453eb8 100644
--- a/schema.json
+++ b/schema.json
@@ -1,9 +1,70 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "StaticConfig",
-  "description": "The `komorebi.json` static configuration file reference for `v0.1.27`",
+  "description": "The `komorebi.json` static configuration file reference for `v0.1.28`",
   "type": "object",
   "properties": {
+    "animation": {
+      "description": "Animations configuration options",
+      "type": "object",
+      "required": [
+        "enabled"
+      ],
+      "properties": {
+        "duration": {
+          "description": "Set the animation duration in ms (default: 250)",
+          "type": "integer",
+          "format": "uint64",
+          "minimum": 0.0
+        },
+        "enabled": {
+          "description": "Enable or disable animations (default: false)",
+          "type": "boolean"
+        },
+        "fps": {
+          "description": "Set the animation FPS (default: 60)",
+          "type": "integer",
+          "format": "uint64",
+          "minimum": 0.0
+        },
+        "style": {
+          "description": "Set the animation style (default: Linear)",
+          "type": "string",
+          "enum": [
+            "Linear",
+            "EaseInSine",
+            "EaseOutSine",
+            "EaseInOutSine",
+            "EaseInQuad",
+            "EaseOutQuad",
+            "EaseInOutQuad",
+            "EaseInCubic",
+            "EaseInOutCubic",
+            "EaseInQuart",
+            "EaseOutQuart",
+            "EaseInOutQuart",
+            "EaseInQuint",
+            "EaseOutQuint",
+            "EaseInOutQuint",
+            "EaseInExpo",
+            "EaseOutExpo",
+            "EaseInOutExpo",
+            "EaseInCirc",
+            "EaseOutCirc",
+            "EaseInOutCirc",
+            "EaseInBack",
+            "EaseOutBack",
+            "EaseInOutBack",
+            "EaseInElastic",
+            "EaseOutElastic",
+            "EaseInOutElastic",
+            "EaseInBounce",
+            "EaseOutBounce",
+            "EaseInOutBounce"
+          ]
+        }
+      }
+    },
     "app_specific_configuration_path": {
       "description": "Path to applications.yaml from komorebi-application-specific-configurations (default: None)",
       "type": "string"
@@ -50,7 +111,8 @@
             },
             {
               "description": "Colour represented as Hex",
-              "type": "string"
+              "type": "string",
+              "format": "color-hex"
             }
           ]
         },
@@ -88,7 +150,8 @@
             },
             {
               "description": "Colour represented as Hex",
-              "type": "string"
+              "type": "string",
+              "format": "color-hex"
             }
           ]
         },
@@ -126,7 +189,8 @@
             },
             {
               "description": "Colour represented as Hex",
-              "type": "string"
+              "type": "string",
+              "format": "color-hex"
             }
           ]
         },
@@ -164,12 +228,32 @@
             },
             {
               "description": "Colour represented as Hex",
-              "type": "string"
+              "type": "string",
+              "format": "color-hex"
             }
           ]
         }
       }
     },
+    "border_implementation": {
+      "description": "Display an active window border (default: false)",
+      "oneOf": [
+        {
+          "description": "Use the adjustable komorebi border implementation",
+          "type": "string",
+          "enum": [
+            "Komorebi"
+          ]
+        },
+        {
+          "description": "Use the thin Windows accent border implementation",
+          "type": "string",
+          "enum": [
+            "Windows"
+          ]
+        }
+      ]
+    },
     "border_offset": {
       "description": "Offset of the window border (default: -1)",
       "type": "integer",
@@ -674,6 +758,16 @@
         ]
       }
     },
+    "minimum_window_height": {
+      "description": "DISCOURAGED: Minimum height for a window to be eligible for tiling",
+      "type": "integer",
+      "format": "int32"
+    },
+    "minimum_window_width": {
+      "description": "DISCOURAGED: Minimum width for a window to be eligible for tiling",
+      "type": "integer",
+      "format": "int32"
+    },
     "monitor_index_preferences": {
       "description": "Set monitor index preferences",
       "type": "object",
@@ -796,6 +890,10 @@
                 "name"
               ],
               "properties": {
+                "apply_window_based_work_area_offset": {
+                  "description": "Apply this monitor's window-based work area offset (default: true)",
+                  "type": "boolean"
+                },
                 "container_padding": {
                   "description": "Container padding (default: global)",
                   "type": "integer",
@@ -1094,7 +1192,8 @@
                 },
                 {
                   "description": "Colour represented as Hex",
-                  "type": "string"
+                  "type": "string",
+                  "format": "color-hex"
                 }
               ]
             },
@@ -1132,10 +1231,20 @@
                 },
                 {
                   "description": "Colour represented as Hex",
-                  "type": "string"
+                  "type": "string",
+                  "format": "color-hex"
                 }
               ]
             },
+            "font_family": {
+              "description": "Font family",
+              "type": "string"
+            },
+            "font_size": {
+              "description": "Font size",
+              "type": "integer",
+              "format": "int32"
+            },
             "unfocused_text": {
               "description": "Unfocused tab text colour",
               "anyOf": [
@@ -1170,7 +1279,8 @@
                 },
                 {
                   "description": "Colour represented as Hex",
-                  "type": "string"
+                  "type": "string",
+                  "format": "color-hex"
                 }
               ]
             },
@@ -1315,7 +1425,7 @@
       ]
     },
     "window_hiding_behaviour": {
-      "description": "Which Windows signal to use when hiding windows (default: minimize)",
+      "description": "Which Windows signal to use when hiding windows (default: Cloak)",
       "oneOf": [
         {
           "description": "Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)",
@@ -1332,7 +1442,7 @@
           ]
         },
         {
-          "description": "Use the undocumented SetCloak Win32 function to hide windows when switching workspaces (has foregrounding issues)",
+          "description": "Use the undocumented SetCloak Win32 function to hide windows when switching workspaces",
           "type": "string",
           "enum": [
             "Cloak"