-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: create documentation improvement issue template (#57)
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 [...]" |