Skip to content

Commit

Permalink
chore: create documentation improvement issue template (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
rouille authored Apr 30, 2021
1 parent aef11ce commit 372d375
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Documentation improvement
about: Create a report to help us improve the documentation
title: Documentation improvement
labels: documentation
assignees: ahurli, BainanXia, danielolsen, jon-hagg, rouille

---

# :book:

### Problem
Tell us about the confusion introduced in the documentation:
* **Ambiguous**
"[...] made me think that [...] when really it should be [...]"
"I found [...] to be unclear because [...]"
* **Missing**
"There is no example showing how to do [...]"
* **Wrong**
"The Installation Guide says to run `[...]` when it should be `[...]`"
* **Outdated**
"The function `foo` used in the code snippet has been renamed to `bar`"

If you are referencing an existing piece of documentation or example please provide a link.

### Suggested Improvement
If you have an idea to improve the documentation please suggest it here
* "This line should be be changed to say [...]"
* "Include a paragraph explaining [...]"
* "Add a figure showing [...]"

0 comments on commit 372d375

Please sign in to comment.