From 55f3a68bf09400bc1be88876d4ed163853240f56 Mon Sep 17 00:00:00 2001
From: Nicolas Mowen <nickmowen213@gmail.com>
Date: Wed, 23 Oct 2024 08:13:59 -0600
Subject: [PATCH] Add basic docs

---
 docs/docs/configuration/face_recognition.md | 23 +++++++++++++++++++++
 docs/sidebars.ts                            |  1 +
 2 files changed, 24 insertions(+)
 create mode 100644 docs/docs/configuration/face_recognition.md

diff --git a/docs/docs/configuration/face_recognition.md b/docs/docs/configuration/face_recognition.md
new file mode 100644
index 000000000..9104fbde0
--- /dev/null
+++ b/docs/docs/configuration/face_recognition.md
@@ -0,0 +1,23 @@
+---
+id: face_recognition
+title: Face Recognition
+---
+
+Face recognition allows people to be assigned names and when their face is recognized Frigate will assign the person's name as a sub label. This information is included in the UI, filters, as well as in notifications.
+
+Frigate has support for FaceNet to create face embeddings, which runs locally. Embeddings are then saved to Frigate's database.
+
+## Minimum System Requirements
+
+Face recognition works by running a large AI model locally on your system. Systems without a GPU will not run Face Recognition reliably or at all.
+
+## Configuration
+
+Face recognition is disabled by default and requires semantic search to be enabled, face recognition must be enabled in your config file before it can be used. Semantic Search and face recognition are global configuration settings.
+
+```yaml
+semantic_search:
+  enabled: True
+  face_recognition:
+    enabled: true
+```
\ No newline at end of file
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
index f8e8780b6..1038b1f98 100644
--- a/docs/sidebars.ts
+++ b/docs/sidebars.ts
@@ -36,6 +36,7 @@ const sidebars: SidebarsConfig = {
       'Semantic Search': [
         'configuration/semantic_search',
         'configuration/genai',
+        'configuration/face_recognition',
       ],
       Cameras: [
         'configuration/cameras',