docs(mkdocs): updates to prepare for v0.1.37

docs/common-workflows/animations.md

@@ -6,7 +6,10 @@ defined in the `komorebi.json` configuration file.
 ```json
 {
   "animation": {
-    "enabled": true
+    "enabled": true,
+    "duration": 250,
+    "fps": 60,
+    "style": "EaseOutSine"
   }
 }
 ```

docs/common-workflows/multi-monitor-setup.md

@@ -301,7 +301,7 @@ how to map the indices and would use default behaviour which would result in a m
 }
 ```
 
-# Multiple Monitors on different machines
+# Multiple monitors on different machines
 
 You can use the same `komorebi.json` to configure two different setups and then synchronize your config across machines.
 However, if you do this it is important to be aware of a few things.
@@ -393,6 +393,13 @@ This is because komorebi will apply the appropriate config to the loaded monitor
 index (the index defined in the user config) to the actual monitor index, and the bar will use that map to know if it
 should be enabled, and where it should be drawn.
 
+# Windows Display Settings
+
+In `Settings > System > Display > Multiple Displays`:
+
+- Disable "Remember windows locations on monitor connection"
+- Enable "Minimize windows when a monitor is disconnected"
+
 ### Things to keep in mind
 
 * If you are using a laptop connected to one monitor at work and a different one at home, the work monitor and the home

docs/common-workflows/set-display-index.md

@@ -1,17 +0,0 @@
-# Setting a Given Display to a Specific Index
-
-If you would like `komorebi` to remember monitor index positions, you will need to set the `display_index_preferences`
-configuration option in the static configuration file.
-
-Display IDs can be found using `komorebic monitor-information`.
-
-Then, in `komorebi.json`, you simply need to specify the preferred index position for each display ID:
-
-```json
-{
-  "display_index_preferences": {
-    "0": "DEL4310-5&1a6c0954&0&UID209155",
-    "1": "<another-display_id>"
-  }
-}
-```

docs/example-configurations.md

@@ -186,6 +186,9 @@ limitations on hotkey bindings that include the `win` key. However, you will sti
 to [modify the registry](https://superuser.com/questions/1059511/how-to-disable-winl-in-windows-10) to prevent
 `win + l` from locking the operating system.
 
+You can toggle an overlay of the current `whkdrc` shortcuts related to `komorebi` at any time when using the example
+configuration with `alt + i`.
+
 ```
 {% include "./whkdrc.sample" %}
 ```

docs/komorebi.bar.example.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.36/schema.bar.json",
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.37/schema.bar.json",
   "monitor": 0,
   "font_family": "JetBrains Mono",
   "theme": {

docs/komorebi.example.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.36/schema.json",
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.37/schema.json",
   "app_specific_configuration_path": "$Env:USERPROFILE/applications.json",
   "window_hiding_behaviour": "Cloak",
   "cross_monitor_move_behaviour": "Insert",

docs/troubleshooting.md

@@ -138,13 +138,14 @@ running `komorebic stop` and `komorebic start`.
 Users with Nvidia GPUs may have issues with transparency on the Komorebi Bar.
 
 To solve this the user can do the following:
-1. Open the Nvidia Control Panel
-2. On the left menu tree, under "3D Settings", select "Manage 3D Settings"
-3. Select the "Program Settings" tab
-4. Press the "Add" button and select "komorebi-bar"
-5. Under "3. Specify the settings for this program:", find the feature labelled, "OpenGL GDI compatibility"
-6. Change the setting to "Prefer compatibility"
-7. At the bottom of the window select "Apply"
-8. Restart the Komorebi Bar with "komorebic stop --bar; komorebic start --bar"
+
+- Open the Nvidia Control Panel
+- On the left menu tree, under "3D Settings", select "Manage 3D Settings"
+- Select the "Program Settings" tab
+- Press the "Add" button and select "komorebi-bar"
+- Under "3. Specify the settings for this program:", find the feature labelled, "OpenGL GDI compatibility"
+- Change the setting to "Prefer compatibility"
+- At the bottom of the window select "Apply"
+- Restart the Komorebi Bar with "komorebic stop --bar; komorebic start --bar"
 
 This should resolve the issue and your Komorebi Bar should render with the proper transparency.

komorebi/src/stackbar_manager/mod.rs

@@ -29,7 +29,7 @@ pub static STACKBAR_TAB_BACKGROUND_COLOUR: AtomicU32 = AtomicU32::new(3355443);
 pub static STACKBAR_TAB_HEIGHT: AtomicI32 = AtomicI32::new(40);
 pub static STACKBAR_TAB_WIDTH: AtomicI32 = AtomicI32::new(200);
 pub static STACKBAR_LABEL: AtomicCell<StackbarLabel> = AtomicCell::new(StackbarLabel::Process);
-pub static STACKBAR_MODE: AtomicCell<StackbarMode> = AtomicCell::new(StackbarMode::OnStack);
+pub static STACKBAR_MODE: AtomicCell<StackbarMode> = AtomicCell::new(StackbarMode::Never);
 
 pub static STACKBAR_TEMPORARILY_DISABLED: AtomicBool = AtomicBool::new(false);
 

komorebi/src/static_config.rs

@@ -807,7 +807,7 @@ pub struct StackbarConfig {
     /// Stackbar label
     #[serde(skip_serializing_if = "Option::is_none")]
     pub label: Option<StackbarLabel>,
-    /// Stackbar mode
+    /// Stackbar mode (default: Never)
     #[serde(skip_serializing_if = "Option::is_none")]
     pub mode: Option<StackbarMode>,
     /// Stackbar tab configuration options

mkdocs.yml

@@ -80,7 +80,6 @@ nav:
           - common-workflows/tray-and-multi-window-applications.md
           - common-workflows/mouse-follows-focus.md
           - common-workflows/dynamic-layout-switching.md
-          - common-workflows/set-display-index.md
           - common-workflows/multiple-bar-instances.md
           - common-workflows/multi-monitor-setup.md
   - CLI reference: