tauri-docs
tauri-docs copied to clipboard
[request] Add a "Report a Documentation Issue" button / input to Docs Pages
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