From 3f60091ce0577e7b8a7eb6336d94b78add410506 Mon Sep 17 00:00:00 2001
From: Nick Mowen <nickmowen213@gmail.com>
Date: Thu, 17 Mar 2022 13:41:48 -0600
Subject: [PATCH] Add birdseye docs

---
 docs/docs/configuration/birdseye.md | 14 ++++++++++++++
 docs/sidebars.js                    |  1 +
 2 files changed, 15 insertions(+)
 create mode 100644 docs/docs/configuration/birdseye.md

diff --git a/docs/docs/configuration/birdseye.md b/docs/docs/configuration/birdseye.md
new file mode 100644
index 000000000..a3f05a107
--- /dev/null
+++ b/docs/docs/configuration/birdseye.md
@@ -0,0 +1,14 @@
+# Birdseye
+
+Birdseye allows a heads-up view of your cameras to see what is going on around your property / space without having to watch all cameras that may have nothing happening. Birdseye allows specific modes that intelligently show and disappear based on what you care about. 
+
+### Birdseye Modes
+
+Birdseye offers different modes to customize which cameras show under which circumstances.
+ - **continuous:** All cameras are always included
+ - **motion:** Cameras that have detected motion within the last 30 seconds are included
+ - **objects:** Cameras that have tracked an active object within the last 30 seconds are included
+
+### Custom Birdseye Icon
+
+A custom icon can be added to the birdseye background by provided a file `custom.png` inside of the Frigate `media` folder. The file must be a png with the icon as transparent, any non-transparent pixels will be white when displayed in the birdseye view. 
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 2b3669bdf..df330936f 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -22,6 +22,7 @@ module.exports = {
       'configuration/objects',
       'configuration/rtmp',
       'configuration/zones',
+      'configuration/birdseye',
       'configuration/advanced',
       'configuration/hardware_acceleration',
       'configuration/nvdec',