Update Docs

AzonInc · Aug 13, 2024 · f74c0fd · f74c0fd
1 parent 99230c2
commit f74c0fd
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 45 deletions.
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -13,6 +13,7 @@
     white-space: nowrap;
     transition: color .25s, border-color .25s, background-color .25s;
     text-decoration: none;
+    cursor: pointer;
 }
 
 .custom-layout .btn:hover {

diff --git a/docs/firmware/nuki-bridge-firmware.md b/docs/firmware/nuki-bridge-firmware.md
@@ -6,8 +6,8 @@ It doesn't support Improv via Bluetooth LE because the BLE Stack is used by the
 ### Update Firmware
 There are a few ways to update the firmware:
 - ESPHome OTA <Badge type="warning" text="Requires ESPHome Dashboard" />
-- HTTP OTA <Badge type="tip" text="Latest release build" />
-- Web Serial <Badge type="tip" text="Latest release build & custom firmware" />
+- HTTP OTA <Badge type="tip" text="Latest release build, no customization" />
+- Web Serial <Badge type="tip" text="Latest release build, no customization" />
 
 You can connect your Doorman via USB-C and click the button below to install the latest and greatest Doorman Nuki Bridge Firmware right here via Web Serial.
 <esp-web-install-button manifest="https://doorman.azon.ai/firmware/release/doorman-nuki-bridge/manifest.json">
@@ -30,7 +30,34 @@ You can connect your Doorman via USB-C and click the button below to install the
     </div>
 </esp-web-install-button>
 
-## Entities
+## Firmware YAML
+This is the minimal ESPHome configuration yaml file, make sure to change the API key.
+
+::: details Minimal Nuki Bridge Firmware
+```yaml
+<!--@include: ../../firmware/examples/nuki-bridge.example.yaml-->
+```
+:::
+
+## Pairing your Nuki Lock
+Depending on the PCB revision, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple or turn on the `Nuki Pairing Mode` switch in Home Assistant. Press the Button on your Nuki Lock for 5 seconds until the light-ring turns on.
+
+After a successfully pairing the Status LED will stay constantly turned on for 3 seconds.
+::: warning
+If you already paired your Nuki Lock this will unpair it!
+:::
+
+## Unpairing your Nuki Lock
+You can use the `Nuki Unpair Device` Button in Home Assistant or the physical `FLASH` or `PRG` button on the Doorman PCB.
+
+::: info Physical Button
+If your Lock is already paired with Doorman, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple.
+Your Nuki Lock is now unpaired. The pairing mode will time out after 30 seconds.
+:::
+
+<!--@include: ./additions.md-->
+
+## Entity Overview
 
 ### Locks
 - Nuki Lock `nuki_smart_lock`
@@ -78,30 +105,4 @@ You can connect your Doorman via USB-C and click the button below to install the
 - Command: Hang up phone `hang_up_phone_command_input` <Badge type="info" text="Disabled by default" />
 - Command: Ring To Open Toggle `ring_to_open_toggle_command_input` <Badge type="info" text="Disabled by default" />
 - Ring To Open: Delay `doorman_ring_to_open_delay` <Badge type="info" text="Disabled by default" />
-- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` <Badge type="info" text="Disabled by default" />
-
-## Pairing your Nuki Lock
-Depending on the PCB revision, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple or turn on the `Nuki Pairing Mode` switch in Home Assistant. Press the Button on your Nuki Lock for 5 seconds until the light-ring turns on.
-
-After a successfully pairing the Status LED will stay constantly turned on for 3 seconds.
-::: warning
-If you already paired your Nuki Lock this will unpair it!
-:::
-
-## Unpairing your Nuki Lock
-You can use the `Nuki Unpair Device` Button in Home Assistant or the physical `FLASH` or `PRG` button on the Doorman PCB.
-
-::: info Physical Button
-If your Lock is already paired with Doorman, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple.
-Your Nuki Lock is now unpaired. The pairing mode will time out after 30 seconds.
-:::
-
-
-## Firmware
-::: details Minimal Nuki Bridge Firmware
-```yaml
-<!--@include: ../../firmware/examples/nuki-bridge.example.yaml-->
-```
-:::
-
-<!--@include: ./additions.md-->
+- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` <Badge type="info" text="Disabled by default" />
diff --git a/docs/firmware/stock-firmware.md b/docs/firmware/stock-firmware.md
@@ -6,8 +6,8 @@ It supports Improv via Bluetooth LE.
 ### Update Firmware
 There are a few ways to update the firmware:
 - ESPHome OTA <Badge type="warning" text="Requires ESPHome Dashboard" />
-- HTTP OTA <Badge type="tip" text="Latest release build" />
-- Web Serial <Badge type="tip" text="Latest release build & custom firmware" />
+- HTTP OTA <Badge type="tip" text="Latest release build, no customization" />
+- Web Serial <Badge type="tip" text="Latest release build, no customization" />
 
 You can connect your Doorman via USB-C and click the button below to install the latest and greatest Doorman Stock Firmware right here via Web Serial.
 <esp-web-install-button manifest="https://doorman.azon.ai/firmware/release/doorman-stock/manifest.json">
@@ -30,7 +30,18 @@ You can connect your Doorman via USB-C and click the button below to install the
     </div>
 </esp-web-install-button>
 
-## Entities
+## Firmware YAML
+This is the minimal ESPHome configuration yaml file, make sure to change the API key.
+
+::: details Minimal Stock Firmware
+```yaml
+<!--@include: ../../firmware/examples/stock.example.yaml-->
+```
+:::
+
+<!--@include: ./additions.md-->
+
+## Entity Overview
 
 ### Sensors
 - Last Bus Command `last_bus_command`
@@ -67,15 +78,4 @@ You can connect your Doorman via USB-C and click the button below to install the
 - Command: Hang up phone `hang_up_phone_command_input` <Badge type="info" text="Disabled by default" />
 - Command: Ring To Open Toggle `ring_to_open_toggle_command_input` <Badge type="info" text="Disabled by default" />
 - Ring To Open: Delay `doorman_ring_to_open_delay` <Badge type="info" text="Disabled by default" />
-- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` <Badge type="info" text="Disabled by default" />
-
-
-
-## Firmware
-::: details Minimal Stock Firmware
-```yaml
-<!--@include: ../../firmware/examples/stock.example.yaml-->
-```
-:::
-
-<!--@include: ./additions.md-->
+- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` <Badge type="info" text="Disabled by default" />