From 27543cfcf32839e3602b220a865b590e96db5141 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Tue, 28 Sep 2021 23:43:32 +0200 Subject: [PATCH] github: add an issue form for the documentation feedback --- .github/ISSUE_TEMPLATE/feedback.md | 54 +++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md index 6c10e389..4046a94b 100644 --- a/.github/ISSUE_TEMPLATE/feedback.md +++ b/.github/ISSUE_TEMPLATE/feedback.md @@ -1,23 +1,47 @@ --- name: Feedback on the documentation -about: Share what we need to explain better +description: Share what we need to explain better url: https://github.com/ueberdosis/tiptap/issues/new title: '' labels: - documentation - - v2 assignees: - hanspagel ---- - -**Part of the documentation?** -I’ve read the following page of the documentation … - -**Really helpful parts** -I think this part is really good: … - -**Hard to understand, missing or misleading** -But you really need to improve … - -**Additional context** -Add any other context or screenshots here. +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to send us feedback! + - type: input + id: url + attributes: + label: The URL of the page + placeholder: https://tiptap.dev/example + validations: + required: false + - type: textarea + id: part-of-the-documentation + attributes: + label: Part of the documentation? + placeholder: "I’ve read the following page of the documentation …" + validations: + required: true + - type: textarea + id: good-parts + attributes: + label: Really helpful parts + placeholder: "I think this part is really good: …" + validations: + required: true + - type: textarea + id: bad-parts + attributes: + label: Hard to understand, missing or misleading + placeholder: "But you really need to improve …" + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context (optional) + placeholder: "Add any other context or screenshots here."