From f57d21039e39dfd0f93416992dda08734a55cf5c Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Sun, 30 Jul 2023 17:29:50 -0600 Subject: [PATCH] Organize configuration sidebar (#7333) * Organize configuration sidebar * Add go2rtc config file * More reorganization --- docs/docs/configuration/autotracking.md | 2 +- docs/docs/configuration/cameras.md | 6 +-- docs/docs/configuration/index.md | 2 +- docs/sidebars.js | 54 ++++++++++++++++--------- 4 files changed, 40 insertions(+), 24 deletions(-) diff --git a/docs/docs/configuration/autotracking.md b/docs/docs/configuration/autotracking.md index 50fd0978f..6c08c3dfe 100644 --- a/docs/docs/configuration/autotracking.md +++ b/docs/docs/configuration/autotracking.md @@ -1,6 +1,6 @@ --- id: autotracking -title: Autotracking +title: Camera Autotracking --- An ONVIF-capable, PTZ (pan-tilt-zoom) camera that supports relative movement within the field of view (FOV) can be configured to automatically track moving objects and keep them in the center of the frame. diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index cc699f254..fd4b53a69 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -1,6 +1,6 @@ --- id: cameras -title: Cameras +title: Camera Configuration --- ## Setting Up Camera Inputs @@ -33,8 +33,8 @@ cameras: roles: - record detect: - width: 1280 # <- optional, by default Frigate tries to automatically detect resolution - height: 720 # <- optional, by default Frigate tries to automatically detect resolution + width: 1280 # <- optional, by default Frigate tries to automatically detect resolution + height: 720 # <- optional, by default Frigate tries to automatically detect resolution ``` Additional cameras are simply added to the config under the `cameras` entry. diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index d3b6e6a40..5bb7963a3 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -1,6 +1,6 @@ --- id: index -title: Configuration File +title: Frigate Configuration Reference --- For Home Assistant Addon installations, the config file needs to be in the root of your Home Assistant config directory (same location as `configuration.yaml`). It can be named `frigate.yaml` or `frigate.yml`, but if both files exist `frigate.yaml` will be preferred and `frigate.yml` will be ignored. diff --git a/docs/sidebars.js b/docs/sidebars.js index bbb9597af..75dfeafce 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -14,25 +14,41 @@ module.exports = { "guides/stationary_objects", "guides/reverse_proxy", ], - Configuration: [ - "configuration/index", - "configuration/object_detectors", - "configuration/audio_detectors", - "configuration/cameras", - "configuration/masks", - "configuration/record", - "configuration/snapshots", - "configuration/objects", - "configuration/restream", - "configuration/live", - "configuration/zones", - "configuration/birdseye", - "configuration/stationary_objects", - "configuration/advanced", - "configuration/hardware_acceleration", - "configuration/camera_specific", - "configuration/ffmpeg_presets", - ], + Configuration: { + "Configuration Files": [ + "configuration/index", + { + type: "link", + label: "Go2RTC Configuration Reference", + href: "https://github.com/AlexxIT/go2rtc/tree/v1.6.2#configuration" + } + ], + Detectors: [ + "configuration/object_detectors", + "configuration/audio_detectors", + ], + Cameras: [ + "configuration/cameras", + "configuration/record", + "configuration/snapshots", + "configuration/birdseye", + "configuration/live", + "configuration/restream", + "configuration/autotracking", + "configuration/camera_specific", + ], + Objects: [ + "configuration/masks", + "configuration/objects", + "configuration/stationary_objects", + "configuration/zones", + ], + "Extra Configuration": [ + "configuration/hardware_acceleration", + "configuration/ffmpeg_presets", + "configuration/advanced", + ], + }, Integrations: [ "integrations/plus", "integrations/home-assistant",