From a07a939e0af8111b1c9a97e3dce8f19e0518c358 Mon Sep 17 00:00:00 2001
From: Dermot Duffy <dermot.duffy@gmail.com>
Date: Sun, 13 Oct 2024 17:31:32 -0700
Subject: [PATCH] docs: Fix PTZ example (#1642)

* docs: Fix PTZ example

* chore: Strength the github issue templates

* Reduce mandatory information
* Diagnostics information always required
---
 .github/ISSUE_TEMPLATE/bug_report.md       | 53 ++++++++++------------
 .github/ISSUE_TEMPLATE/feature_request.md  | 10 ++--
 docs/configuration/actions/stock/README.md | 11 -----
 docs/examples.md                           | 38 +++++++++-------
 4 files changed, 49 insertions(+), 63 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index d4093fe4..0a3cc5e7 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,52 +1,45 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a report to help the card improve
 title: ''
 labels: bug
 assignees: ''
 ---
 
-<!-- READ THIS FIRST:
-- If you need additional help with this template please refer to https://www.home-assistant.io/help/reporting_issues/
-- Make sure you are running the latest version of Home Assistant before reporting an issue: https://github.com/home-assistant/home-assistant/releases
-- Provide as many details as possible. Do not delete any text from this template!
--->
+<!-- ====================================================================== -->
+<!-- ***               PLEASE DO NOT IGNORE THIS TEMPLATE               *** -->
+<!-- ***                                                                *** -->
+<!-- *** This is the smallest amount of information needed to help you! ***  -->
+<!-- ====================================================================== -->
 
 **Checklist:**
 
-- [ ] I updated to the latest version available
-- [ ] I cleared the cache of my browser
+- Please try updating to the [latest available version](https://github.com/dermotduffy/frigate-hass-card/releases).
+- Please try clearing your browser cache.
 
-**Release with the issue:**
-
-**Last working release (if known):**
-
-**Browser and Operating System:**
+**[REQUIRED] Card diagnostic information:**
 
 <!--
-Provide details about what browser (and version) you are seeing the issue in. And also which operating system this is on. If possible try to replicate the issue in other browsers and include your findings here.
--->
-
-**Description of problem:**
-
-<!--
-Explain what the issue is, and how things should look/behave. If possible provide a screenshot with a description.
--->
-
-**Frigate card diagnostic information**
-
-<!--
-On the card, hold down the Frigate menu button for a few seconds then paste the diagnostics below:
+On the card, hold down the Default/Frigate menu button for a few seconds then paste the diagnostics below. No help can be provided without this
 -->
 
 ```yaml
 
 ```
 
-**Javascript errors shown in the web inspector (if applicable):**
+**[REQUIRED] Description of problem:**
+
+<!--
+Explain what the issue is, and how things should look/behave. If possible provide a screenshot with a description.
+-->
+
+**[OPTIONAL] Last working release (if known):**
+
+
+**[OPTIONAL] Javascript errors shown in the web inspector:**
+
+```text
 
 ```
 
-```
-
-**Additional information:**
+**[OPTIONAL] Additional information:**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 22b00af0..730c21ea 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,14 +6,14 @@ labels: feature request
 assignees: ''
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**[REQUIRED] Describe the feature you'd like:**
 
-**Describe the solution you'd like**
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+**[OPTIONAL] Describe alternatives you've considered:**
+
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+**[OPTIONAL] Additional context:**
+
 Add any other context or screenshots about the feature request here.
diff --git a/docs/configuration/actions/stock/README.md b/docs/configuration/actions/stock/README.md
index 83fbbb4d..805d7219 100644
--- a/docs/configuration/actions/stock/README.md
+++ b/docs/configuration/actions/stock/README.md
@@ -1,16 +1,5 @@
 # Stock Actions
 
-## `call-service`
-
-Call a service. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
-
-!> Home Assistant has deprecated the `call-service` action, please use [`perform-action`](#perform-action) instead.
-
-```yaml
-action: call-service
-# [...]
-```
-
 ## `more-info`
 
 Open the "more-info" dialog for an entity. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
diff --git a/docs/examples.md b/docs/examples.md
index 3e7f66fa..3995957a 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -620,30 +620,34 @@ overrides:
 
 ## PTZ control
 
-The card supports using PTZ controls to conveniently control pan, tilt and zoom for cameras. This example shows the PTZ controls on the `live` view. Note that if your camera engine supports it (e.g. `frigate`) this will just work out of the box with no configuration at all.
+The card supports using PTZ controls to conveniently control pan, tilt and zoom
+for cameras. If you're using a Frigate camera, and Frigate itself shows PTZ
+controls, this should work straight out of the box without any extra configuration:
 
 ```yaml
 type: custom:frigate-card
 cameras:
   - camera_entity: camera.office
-live:
-  ptz:
-    orientation: horizontal
-    service: sonoff.send_command
-    data_left:
-      device: '048123'
-      cmd: left
-    data_right:
-      device: '048123'
-      cmd: right
-    data_up:
-      device: '048123'
-      cmd: up
-    data_down:
-      device: '048123'
-      cmd: down
 ```
 
+If you're using a non-Frigate camera, or Frigate itself does not support the PTZ
+controls on your camera but Home Assistant does, you can still manually
+configure actions for the card to perform for each PTZ control:
+
+```yaml
+type: custom:frigate-card
+cameras:
+  - camera_entity: camera.office
+    ptz:
+      actions_left:
+        action: perform-action
+        perform_action: homeassistant.toggle
+        target:
+          entity_id: switch.camera_move_left
+```
+
+See the full [Camera PTZ Configuration](./configuration/live.md?id=ptz) for more information.
+
 ## `screen` conditions
 
 These examples show altering the card configuration based on device or viewport properties.