Enhance Documentation Feedback Mechanism with Direct Issue Reporting #816
Rajakavitha1
started this conversation in
Feature Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Currently, the "Edit in GitHub" button directs users to the .md file to create a PR, which is great for direct edits but doesn't fully address broader feedback needs.
My suggestion is to add a button (or repurpose the current sad face emoji) that links directly to the GitHub issues page. This would allow users to provide more detailed feedback, such as specifying which document they followed and describing the issues they encountered. This approach would help gather richer and more actionable feedback.
PS: When a user is taken to a .md page to edit, it implies they can make the changes themselves. However, end users typically lack the internal knowledge or understanding of the feature's functionality to make these edits. If they already knew the fix, they likely wouldn't need the documentation in the first place. Providing an easier way for them to report issues aligns better with their needs and improves the feedback loop.
Beta Was this translation helpful? Give feedback.
All reactions