diff --git a/.github/ISSUE_TEMPLATE/04-docs_issue.yml b/.github/ISSUE_TEMPLATE/04-docs_issue.yml new file mode 100644 index 0000000..3445374 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-docs_issue.yml @@ -0,0 +1,40 @@ +name: Documentation issue +description: Report incorrect, unclear, or missing documentation. +labels: [documentation] +body: + - type: checkboxes + attributes: + label: Have you searched if there an existing issue for this? + description: Please search [existing issues](https://github.com/D4Vinci/Scrapling/labels/documentation). + options: + - label: I have searched the existing issues + required: true + + - type: input + attributes: + label: "Page URL" + description: "Link to the documentation page with the issue." + placeholder: "https://scrapling.readthedocs.io/en/latest/..." + validations: + required: true + + - type: dropdown + attributes: + label: "Type of issue" + options: + - Incorrect information + - Unclear or confusing + - Missing information + - Typo or formatting + - Broken link + - Other + default: 0 + validations: + required: true + + - type: textarea + attributes: + label: "Description" + description: "Describe what's wrong and what you expected to find." + validations: + required: true diff --git a/zensical.toml b/zensical.toml index 231d82f..a7b803f 100644 --- a/zensical.toml +++ b/zensical.toml @@ -212,8 +212,8 @@ name = "This page could be improved" data = 0 note = """ Thanks for your feedback! Help us improve this page by -using our feedback form. -""" # TODO: add a new issue template for the docs +opening a documentation issue. +""" [project.extra.consent] title = "Cookie consent"