Skip to content

feat: add documentation feedback form #2614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: 💬 Documentation Feedback
description: Provide feedback or suggestions for improving docs.near.org
title: "[FEEDBACK] "
labels: ["documentation", "feedback"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help us improve our documentation! 🙏
Use this template to share feedback, suggestions, or ideas for making our docs better.

- type: input
id: page-url
attributes:
label: Page URL
placeholder: https://docs.near.org/<path>
validations:
required: true

- type: dropdown
id: feedback_type
attributes:
label: "Feedback Type"
options:
- "General Improvement Suggestion"
- "User Experience Enhancement"
- "Content Organization"
- "Writing Style/Clarity"
- "Additional Examples Needed"
- "Visual/Design Feedback"
- "Other"
validations:
required: true

- type: textarea
id: current_experience
attributes:
label: "Current Experience"
placeholder: "Describe your current experience with this documentation. What works well? What could be better?"
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: "Your Suggestion"
placeholder: "What specific improvements would you like to see? How would this make the documentation better?"
validations:
required: true

- type: textarea
id: use_case
attributes:
label: "Use Case"
placeholder: "What were you trying to accomplish when you encountered this? Who else might benefit from this improvement?"
validations:
required: false

- type: dropdown
id: priority
attributes:
label: "Impact Level"
options:
- "🔴 High : Significantly impacts user experience"
- "🟡 Medium : Noticeable improvement opportunity"
- "🟢 Low : Nice to have enhancement"
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: "Additional Context"
placeholder: "Any other relevant information, examples, or references that might help?"
validations:
required: false
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/epic.md

This file was deleted.

Loading