summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorPeter LaFosse <peter@vector35.com>2022-08-16 08:57:00 -0400
committerGitHub <noreply@github.com>2022-08-16 08:57:00 -0400
commite106e7562dbf06b1c467bd8ee62ac67a68fa2259 (patch)
tree363331be928f191c4245a641c80b5a7e258cd6b7 /.github/ISSUE_TEMPLATE
parent7fa85d4571cfd736b9c7164e8c830b3d585a1550 (diff)
Create documentation.md
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/documentation.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 00000000..fc3e1efd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,19 @@
+---
+name: Request for documentation
+about: Let us know where we can clarify Binary Ninja's documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is this a general concept that needs to be documented or a specifi API?**
+Does this involve a specific API/set of APIs or a whole concept in Binary Ninja (i.e. BinaryViews, Basic Blocks, etc)
+
+**What concept or API needs more documentation?**
+Please provide a clear and concise description of the API or concept which is confusing or missing documentation.
+
+**Is this documentation related to a specifi API?**
+Decribe which API needs documentation. C++ or Python (The C API is not intended to be a documented interface)
+
+**Are there any known examples of people using this API/concept? **