Skip to content

[v2] Integrated Feedback Widget #4808

@yiliansource

Description

@yiliansource

🚀 Feature: Integrated Feedback Widget

This is an adaptation of https://docusaurus.io/feedback/p/feedback-widget.

Finding out whether users actually deem the content on your site useful can be very helpful to gain insights into the quality and clarity of the actual content. Most documentation sites have integrated feedback widgets, and I (and according to the feedback page many others) think that this could be a valuable addition.

Have you read the Contributing Guidelines on issues?

Yes!

Motivation

I have been browsing around various documentation pages, trying to find out which features are currently lacking in Docusaurus, that could be deemed useful to developers. When I found the post on the feedback page (from 2 years ago!) I wanted to bring the idea back up. I apologize in advance if this is already implemented and was simply overlooked by me.

Pitch

I believe this can be seamlessly integrated into a new package, which could potentially even ship with the default theme. Users would simply have to decide between a layout (with a default given) and a reporting method (more later) to activate the widget.

Reporting

I will describe two possible methods that came to my mind. Since the site is completely static, there's no way for us to store data on the site. Using a tool like staticman could work, but is too tedious to use in this case (in my opinion), since it forces you to continuously merge the reported data into your actual repository.

Google Sheets

Simple; use a public Google Sheet where the data is stored. Data can be queried to display the overall feedback on a single page and can be posted to update the data.

The huge disadvantage is that the sheet is public, no one prevents users from just opening the sheet themselves and mess around with it.

Google Analytics

Slightly more setup, but could be well worth it.

I found that the feedback widget on the React-Native Docusaurus page uses Google Analytics to report the feedback. Using the Analytics Reporting API v4 from Google, we could send and query data directly from Google Analytics. This could potentially even synergise together with the existing Google Analytics plugin.

Layouts

Various layouts could be supported, since they all cover the same values (negative/(neutral)/positive). Examples:

GitBook React-Native Unknown (taken from the feedback page)
image image image

I'd be happy to give developing this a try, even if it will not be officially integrated. I would love some feedback on the idea overall and the pitched implementation concepts!

Metadata

Metadata

Assignees

No one assigned

    Labels

    closed: wontfixA fix will bring significant overhead, or is out of scope (for feature requests)featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions