Picovoice · laves · Dec 14, 2023 · Dec 13, 2023 · Dec 13, 2023 · Dec 13, 2023
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,106 @@
+name: Bug report
+description: Bugs in Porcupine
+title: "Porcupine Issue: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Before** reporting an issue, make sure to read the [documentation](https://picovoice.ai/docs/porcupine/) and search [existing issues](https://github.com/Picovoice/porcupine/issues).
+  - type: checkboxes
+    id: check
+    attributes:
+      label: Have you checked the docs and existing issues?
+      description: Make sure you have checked all of the below before submitting an issue
+      options:
+        - label: I have read all of the relevant Picovoice Porcupine docs
+          required: true
+        - label: I have searched the existing issues for Porcupine
+          required: true
+  - type: dropdown
+    id: sdk
+    attributes:
+      label: SDK
+      options:
+        - Android
+        - Angular
+        - C
+        - .NET
+        - Flutter
+        - Go
+        - iOS
+        - Java
+        - MCU
+        - Node.js
+        - Python
+        - React Native
+        - React
+        - Rust
+        - Unity
+        - Vue
+        - Web
+    validations:
+      required: true
+  - type: input
+    id: package
+    attributes:
+      label: "Porcupine package version"
+      placeholder: "1.0.0"
+    validations:
+      required: true
+  - type: input
+    id: framework
+    attributes:
+      label: "Framework version"
+      placeholder: "Python 3.7, .NET Core 3.1, etc."
+    validations:
+      required: true
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      options:
+        - Android
+        - iOS
+        - Web (WASM)
+        - Linux (x86_64)
+        - macOS (x86_64, arm64)
+        - Windows (x86_64)
+        - Raspberry Pi
+        - NVIDIA Jetson
+        - BeagleBone
+        - ARM Cortex-M
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: "OS/Browser version"
+      placeholder: "macOS 11.0, Android 8.0, etc."
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1.
+        2. 
+        3.
+    validations:
+      required: true
+  - type: textarea
+    id: expectation
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -0,0 +1,18 @@
+name: Documentation
+description: Issues around documentation of Porcupine
+title: "Porcupine Documentation Issue: "
+labels: ["documentation"]
+body:
+  - type: input
+    id: url
+    attributes:
+      label: What is the URL of the doc?
+    validations:
+      required: true
+  - type: textarea
+    id: issue
+    attributes:
+      label: What is the nature of the issue?
+      description: e.g. steps do not work, typos/grammar/spelling, out of date, etc.
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/demo/mcu/stm32f407/README.md b/demo/mcu/stm32f407/README.md
@@ -27,12 +27,12 @@ This package contains a demo project for the STM32F407 Discovery kit using Porcu
 ## Installation
 
 For this demo, you need to:
-
+<!-- markdown-link-check-disable -->
 1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an
    all-in-one multi-OS development tool for STM32 microcontrollers.
 2. Download [STM32Cube MCU Package for STM32F4 series](https://www.st.com/en/embedded-software/stm32cubef4.html) and
    extract it somewhere on your computer.
-
+<!-- markdown-link-check-enable -->
 ## AccessKey
 
 Porcupine requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using
@@ -63,11 +63,11 @@ Then, to compile and run the demo project on a STM32f407 discovery board, perfor
 7. Connect the board to the computer and press `Run` > `Debug`
 8. There are two build configurations in this project: Single wake word demo, and Multiple wake words demo; choose one
    of them in the `Qualifier` window and press `ok`
-
+<!-- markdown-link-check-disable -->
 > :warning: `printf()` uses the SWO connector and the trace port 0. For more information, refer
 > to [STM32 microcontroller debug toolbox](https://www.st.com/resource/en/application_note/dm00354244-stm32-microcontroller-debug-toolbox-stmicroelectronics.pdf)
 > , Chapter 7.
-
+<!-- markdown-link-check-enable -->
 For single wake-word demos, you can identify the default keyword for each language by referring to the [pv_params.h](./stm32f407g-disc1/Inc/pv_params.h) file. Within this file, locate the language section enclosed by:
 
 ```c

diff --git a/demo/mcu/stm32f411/README.md b/demo/mcu/stm32f411/README.md
@@ -26,12 +26,12 @@ This package contains a demo project for the STM32F411 Discovery kit using Porcu
 ## Installation
 
 For this demo, you need to:
-
+<!-- markdown-link-check-disable -->
 1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an
    all-in-one multi-OS development tool for STM32 microcontrollers.
 2. Download [STM32Cube MCU Package for STM32F4 series](https://www.st.com/en/embedded-software/stm32cubef4.html) and
    extract it somewhere on your computer.
-
+<!-- markdown-link-check-enable -->
 ## AccessKey
 
 Porcupine requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using
@@ -62,12 +62,12 @@ Then, to compile and run the demo project on a STM32f411 discovery board, perfor
 7. Connect the board to the computer and press `Run` > `Debug`
 8. There are two build configurations in this project: Single wake word demo, and Multiple wake words demo; choose one
    of them in the `Qualifier` window and press `ok`
-
+<!-- markdown-link-check-disable -->
 > :warning: `printf()` uses the SWO connector and the trace port 0. For more information, refer
 >
 to [STM32 microcontroller debug toolbox](https://www.st.com/resource/en/application_note/dm00354244-stm32-microcontroller-debug-toolbox-stmicroelectronics.pdf)
 > , Chapter 7.
-
+<!-- markdown-link-check-enable -->
 For single wake-word demos, you can identify the default keyword for each language by referring to the [pv_params.h](./stm32f411e-disco/Inc/pv_params.h) file. Within this file, locate the language section enclosed by:
 
 ```c

diff --git a/demo/mcu/stm32f769/README.md b/demo/mcu/stm32f769/README.md
@@ -26,9 +26,9 @@ This package contains a demo project for the STM32F769 Discovery kit using Porcu
 ## Installation
 
 For this demo, you need to:
-
+<!-- markdown-link-check-disable -->
 1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an
-   all-in-one multi-OS development tool for STM32 microcontrollers.
+   all-in-one multi-OS development tool for STM32 microcontrollers. <!-- markdown-link-check-enable -->
 2. Install a serial port monitor on your system to be able to communicate with the
    board. [Arduino environment's built-in serial monitor](https://www.arduino.cc/en/software)
    and [Coolterm](https://freeware.the-meiers.org/) are two free options available on all platforms (Windows, Linux, and