Skip to content

[request] Add a "Report a Documentation Issue" button / input to Docs Pages #3267

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

Open
1 task
senft-research opened this issue Apr 17, 2025 · 0 comments
Open
1 task
Labels
discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content?

Comments

@senft-research
Copy link
Contributor

Question you want answered

Do you have an issue with this page / section?

Where did you look for an answer?

As explained below, it is nigh-impossible to look for a solid answer to this question, as those that did usually do not stick around long enough to tell us.

Page URL

No response

Additional context

Background:

As someone who is relatively new to Tauri, but also a Lecturer, I can say with confidence that I have already found myself at "The Hump".
"The Hump" in this case is in reference to the stage of learning something new, where you get frustrated to the point of needing to step away. A poorly written paragraph in a book, an unclear diagram in a Lecture etc.

For me, this hump in Tauri came from the multi-level menu documentation. This was my hump as, for me, menus are one of the first things I want to know how to make in a new desktop app framework.
I’ve since created a PR to help address it, but it highlighted a broader issue:

When developers hit that wall, they often don't stick around to tell you where it was.

Proposal

Add a small "Report a Problem" button to documentation pages, allowing users to submit quick feedback about what confused or frustrated them. Upon submission:

  • Ask the user if they want to create a GitHub issue (and provide a link)
  • Send the feedback to a database or endpoint
  • The data from this db is used to visualize the feedback in a dashboard. (e.g., a heatmap or histogram of frustration points across pages etc)

This helps maintainers and contributors identify patterns: where users are getting stuck, and which parts of the docs need improvement, even if no one opens a formal issue.

Why this matters

For an open-source framework still growing its community, I believe having more context as to where "drop off points" in the documentation are is invaluable. It helps prioritize contributions to the documentation, improves the on-boarding experience, and reduces the number of developers who end up not adopting Tauri long-term.

Are you willing to work on this yourself?

  • I want to work on this myself
@senft-research senft-research added discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content? labels Apr 17, 2025
@github-project-automation github-project-automation bot moved this to 🪵 Backlog in Documentation Apr 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content?
Projects
Status: 🪵 Backlog
Development

No branches or pull requests

1 participant