Skip to content

Commit 369017c

Browse files
feat: add documentation feedback form (#2614)
* fix: remove epic issue * feat: add doc feedback form
1 parent 9ff8651 commit 369017c

File tree

2 files changed

+77
-37
lines changed

2 files changed

+77
-37
lines changed
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: 💬 Documentation Feedback
2+
description: Provide feedback or suggestions for improving docs.near.org
3+
title: "[FEEDBACK] "
4+
labels: ["documentation", "feedback"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to help us improve our documentation! 🙏
11+
Use this template to share feedback, suggestions, or ideas for making our docs better.
12+
13+
- type: input
14+
id: page-url
15+
attributes:
16+
label: Page URL
17+
placeholder: https://docs.near.org/<path>
18+
validations:
19+
required: true
20+
21+
- type: dropdown
22+
id: feedback_type
23+
attributes:
24+
label: "Feedback Type"
25+
options:
26+
- "General Improvement Suggestion"
27+
- "User Experience Enhancement"
28+
- "Content Organization"
29+
- "Writing Style/Clarity"
30+
- "Additional Examples Needed"
31+
- "Visual/Design Feedback"
32+
- "Other"
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: current_experience
38+
attributes:
39+
label: "Current Experience"
40+
placeholder: "Describe your current experience with this documentation. What works well? What could be better?"
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: suggestion
46+
attributes:
47+
label: "Your Suggestion"
48+
placeholder: "What specific improvements would you like to see? How would this make the documentation better?"
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: use_case
54+
attributes:
55+
label: "Use Case"
56+
placeholder: "What were you trying to accomplish when you encountered this? Who else might benefit from this improvement?"
57+
validations:
58+
required: false
59+
60+
- type: dropdown
61+
id: priority
62+
attributes:
63+
label: "Impact Level"
64+
options:
65+
- "🔴 High : Significantly impacts user experience"
66+
- "🟡 Medium : Noticeable improvement opportunity"
67+
- "🟢 Low : Nice to have enhancement"
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: additional_context
73+
attributes:
74+
label: "Additional Context"
75+
placeholder: "Any other relevant information, examples, or references that might help?"
76+
validations:
77+
required: false

.github/ISSUE_TEMPLATE/epic.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)