tauri-apps / tauri-apps/tauri-docs

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

Open
#3,267 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

discuss enhancement
Dominant language
MDX
Stars
1.1k
Forks
887
Avg merge
2d 8h
Merged PRs (30d)
48

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named; start by locating how the documentation pages are implemented and whether feedback or analytics infrastructure already exists. Clarify the scope of the submission flow, GitHub issue link, endpoint or database, and dashboard before coding. Done means documentation readers can submit feedback and maintainers can review aggregated problem areas.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design, data-visualization, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.