2023-03-29 17:53:27 +08:00
|
|
|
|
name: Documentation feedback
|
2023-09-25 15:06:21 +08:00
|
|
|
|
description: Share what we need to explain better.
|
2023-03-29 17:53:27 +08:00
|
|
|
|
title: "[Documentation]: "
|
2021-04-22 03:28:43 +08:00
|
|
|
|
labels:
|
2023-03-29 17:53:27 +08:00
|
|
|
|
- "Type: Documentation"
|
|
|
|
|
|
- "Category: Open Source"
|
|
|
|
|
|
- "Status: New"
|
2021-09-29 05:43:32 +08:00
|
|
|
|
body:
|
|
|
|
|
|
- type: input
|
|
|
|
|
|
id: url
|
|
|
|
|
|
attributes:
|
2021-09-29 05:50:20 +08:00
|
|
|
|
label: What’s the URL to the page you’re sending feedback for?
|
2021-09-29 05:43:32 +08:00
|
|
|
|
placeholder: https://tiptap.dev/example
|
|
|
|
|
|
validations:
|
2021-09-29 05:53:29 +08:00
|
|
|
|
required: true
|
2021-09-29 05:43:32 +08:00
|
|
|
|
- type: textarea
|
|
|
|
|
|
id: part-of-the-documentation
|
|
|
|
|
|
attributes:
|
2021-09-29 05:50:20 +08:00
|
|
|
|
label: What part of the documentation needs improvement?
|
2021-09-29 05:43:32 +08:00
|
|
|
|
placeholder: "I’ve read the following page of the documentation …"
|
|
|
|
|
|
validations:
|
|
|
|
|
|
required: true
|
|
|
|
|
|
- type: textarea
|
|
|
|
|
|
id: good-parts
|
|
|
|
|
|
attributes:
|
2021-09-29 05:50:20 +08:00
|
|
|
|
label: What is helpful about that part?
|
2021-09-29 05:43:32 +08:00
|
|
|
|
placeholder: "I think this part is really good: …"
|
|
|
|
|
|
validations:
|
|
|
|
|
|
required: true
|
|
|
|
|
|
- type: textarea
|
|
|
|
|
|
id: bad-parts
|
|
|
|
|
|
attributes:
|
2021-09-29 05:50:20 +08:00
|
|
|
|
label: What is hard to understand, missing or misleading?
|
2021-09-29 05:43:32 +08:00
|
|
|
|
placeholder: "But you really need to improve …"
|
|
|
|
|
|
validations:
|
|
|
|
|
|
required: true
|
|
|
|
|
|
- type: textarea
|
|
|
|
|
|
id: context
|
|
|
|
|
|
attributes:
|
2021-09-29 05:50:20 +08:00
|
|
|
|
label: Anything to add? (optional)
|
2021-09-29 06:24:46 +08:00
|
|
|
|
description: "Add any other context or screenshots here."
|
2021-09-29 05:52:47 +08:00
|
|
|
|
- type: markdown
|
|
|
|
|
|
attributes:
|
|
|
|
|
|
value: |
|
|
|
|
|
|
Thanks for taking the time to send us feedback!
|
