Karim shoair commited on
Commit ·
09ccda6
1
Parent(s): 7c719ac
docs: add a new issue template for documentation issues
Browse files- .github/ISSUE_TEMPLATE/04-docs_issue.yml +40 -0
- zensical.toml +2 -2
.github/ISSUE_TEMPLATE/04-docs_issue.yml
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: Documentation issue
|
| 2 |
+
description: Report incorrect, unclear, or missing documentation.
|
| 3 |
+
labels: [documentation]
|
| 4 |
+
body:
|
| 5 |
+
- type: checkboxes
|
| 6 |
+
attributes:
|
| 7 |
+
label: Have you searched if there an existing issue for this?
|
| 8 |
+
description: Please search [existing issues](https://github.com/D4Vinci/Scrapling/labels/documentation).
|
| 9 |
+
options:
|
| 10 |
+
- label: I have searched the existing issues
|
| 11 |
+
required: true
|
| 12 |
+
|
| 13 |
+
- type: input
|
| 14 |
+
attributes:
|
| 15 |
+
label: "Page URL"
|
| 16 |
+
description: "Link to the documentation page with the issue."
|
| 17 |
+
placeholder: "https://scrapling.readthedocs.io/en/latest/..."
|
| 18 |
+
validations:
|
| 19 |
+
required: true
|
| 20 |
+
|
| 21 |
+
- type: dropdown
|
| 22 |
+
attributes:
|
| 23 |
+
label: "Type of issue"
|
| 24 |
+
options:
|
| 25 |
+
- Incorrect information
|
| 26 |
+
- Unclear or confusing
|
| 27 |
+
- Missing information
|
| 28 |
+
- Typo or formatting
|
| 29 |
+
- Broken link
|
| 30 |
+
- Other
|
| 31 |
+
default: 0
|
| 32 |
+
validations:
|
| 33 |
+
required: true
|
| 34 |
+
|
| 35 |
+
- type: textarea
|
| 36 |
+
attributes:
|
| 37 |
+
label: "Description"
|
| 38 |
+
description: "Describe what's wrong and what you expected to find."
|
| 39 |
+
validations:
|
| 40 |
+
required: true
|
zensical.toml
CHANGED
|
@@ -212,8 +212,8 @@ name = "This page could be improved"
|
|
| 212 |
data = 0
|
| 213 |
note = """
|
| 214 |
Thanks for your feedback! Help us improve this page by
|
| 215 |
-
|
| 216 |
-
"""
|
| 217 |
|
| 218 |
[project.extra.consent]
|
| 219 |
title = "Cookie consent"
|
|
|
|
| 212 |
data = 0
|
| 213 |
note = """
|
| 214 |
Thanks for your feedback! Help us improve this page by
|
| 215 |
+
<a href="https://github.com/D4Vinci/Scrapling/issues/new?template=04-docs_issue.yml" target="_blank" rel="noopener">opening a documentation issue</a>.
|
| 216 |
+
"""
|
| 217 |
|
| 218 |
[project.extra.consent]
|
| 219 |
title = "Cookie consent"
|