From 2662f85f9e4396dc3716d980d3ce6627176f3439 Mon Sep 17 00:00:00 2001
From: Qiangqiang Gu <98570179+QG-phy@users.noreply.github.com>
Date: Thu, 14 Sep 2023 10:45:35 +0800
Subject: [PATCH] add  doc issue template: by create documentation.yml

---
 .github/ISSUE_TEMPLATE/documentation.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml

diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
new file mode 100644
index 00000000..26cf635b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -0,0 +1,18 @@
+name: Docs
+description: For users or developers to report issues related to software documentation, such as missing or incomplete documentation, or documentation that is difficult to understand.
+labels: [Docs]
+assignees: Qiangqiang Gu
+body:
+- type: textarea
+  attributes:
+    label: Details
+    description: |
+      Please provide details about the documentation issue you are experiencing. Include any relevant information such as the specific section of the documentation, the information that is missing or unclear, and any suggestions for improvement. 
+    placeholder: |
+      Example: The documentation for the band structure calculations is missing. I have read the online manual, but I am still not sure how to do it. My suggestion is to add a new section to the online manual that describes this.
+  validations:
+      required: true
+- type: markdown
+  attributes:
+    value: >
+      Thank you for reporting this documentation issue. We will review and update the documentation as necessary. 📚