documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Documentation feedback widget

Open yurishkuro opened this issue 6 years ago • 4 comments

I noticed a few things on google cloud docs that might be useful here:

  • a rating widget to get feedback about documentation
  • last updated date (unique per-page)

image

yurishkuro avatar Dec 05 '19 00:12 yurishkuro

I am interested in contributing. So please, briefly explain what to do. @yurishkuro

yashisrani avatar Dec 28 '24 10:12 yashisrani

Hi @yurishkuro ,

Saw this while searching for "feedback widget". I'm the founder of PushFeedback, which adds lightweight feedback widget for docs sites. It has Node.js support and is quick to try out.

Image

It can also be integrated inline at the end of the page, similar to the example you shared:

Image

Would love your thoughts if you're exploring options.

dgarcia360 avatar Jul 08 '25 14:07 dgarcia360

@dgarcia360 I personally not a big fan of floating buttons, they inevitably find a way to interfere with viewing the page content. I do see that you have an inline mode, but it still only renders the button, which feels like an unnecessary friction compared to the star rating in the issue description that can be clicked directly. Is your modal popup a required implementation detail, or can the rating & form be rendered inline too?

yurishkuro avatar Jul 08 '25 19:07 yurishkuro

@yurishkuro Thanks for the feedback! Here's a quick demo showing how the star rating can be implemented inline, without a floating button or modal: https://codepen.io/David-Garcia-the-bashful/pen/ZYbzxEO

We don’t have a dedicated component for this mode yet, but it’s fully achievable using the existing <feedback-button> in inline mode, combined with the submit property to not open the modal.

dgarcia360 avatar Jul 08 '25 22:07 dgarcia360