22 lines
624 B
Markdown
22 lines
624 B
Markdown
|
---
|
||
|
|
name: Documentation issue
|
||
|
|
about: An issue you found with the documentation (README.md, anything from ./doc)
|
||
|
|
title: "[DOC] Title here"
|
||
|
|
labels: ''
|
||
|
|
assignees: ''
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Type**
|
||
|
|
What is the general type of the issue:
|
||
|
|
- misspell - you've found a misspelling somewhere
|
||
|
|
- citation needed - somewhere, citation is needed
|
||
|
|
- unclear - somewhere, the documentation is worded unclearly
|
||
|
|
- not enough info - somewhere in the documentation doesn't provide enough information
|
||
|
|
|
||
|
|
**Description**
|
||
|
|
A short description of what the issue with the documetnation is
|
||
|
|
|
||
|
|
**Location**
|
||
|
|
If applicable, what is the file(s) in which this issue addresses
|