Skip to content

Add Push Feedback feedback button - #2246

Open
jvns wants to merge 1 commit into
git:gh-pagesfrom
jvns:add-feedback-button
Open

jvns wants to merge 1 commit into
git:gh-pagesfrom
jvns:add-feedback-button

Conversation

@jvns

@jvns jvns commented Nov 10, 2026 •

Copy link
Copy Markdown
Collaborator

Add a feedback button on the center right so that users can leave feedback on the docs. Closes #2208. I wrote about the technical changes in the commit message. You can see a live version here: https://jvns.github.io/git-scm.com/docs/git-rebase

Here's what the feedback dashboard looks like. My idea right now is to mainly access the feedback through their website, to avoid creating too many email notifications. The idea is that instead of treating each feedback item as a separate issue to be addressed, instead we look for patterns in the feedback. So we'd wait until there are 10+ comments on a page and then improve it based on the patterns. This could also be used to prioritize which pages to improve, for example if there are pages with a lot of "thumbs down" type feedback.

image

Some issues I can think of:

  • I don't know what processes exist for managing the account. Right now the account ID is from a new free account that I created with my email address. But presumably multiple people should be able to access the feedback dashboard.
  • Related to access to the data: there are some options where people can include their personal information with the feedback (like email address or a screenshot). Those are optional. If we don't want that information at all, we can disable those fields with hide_email. (documentation)
  • I read the Terms briefly and I didn't see anything obviously upsetting.
  • The JS code sets an identifier in localStorage to identify feedback that comes from the same browser. Something like pushfeedback_sessionid:"0yzl41voqmen". This doesn't seem like a privacy issue to me but wanted to flag it just in case.
  • The UI isn't translated into other languages. I think this is okay because our other UI isn't either.
  • I put some instructions for how to upgrade the Push Feedback HTML/CSS in the commit message but I feel like there's probably a better place for it.
  • We might want to make sure that the feedback widget doesn't appear if the user has Javascript disabled.

A bunch of screenshots of various things (light mode, dark mode, mobile, the feedback dialog)

image image image image

Add a feedback button on the center right so that users can leave
feedback on the docs.

- Vendor the code so that we're not including assets from a CDN.
- Make sure it looks okay in dark mode and light mode by using
  a CSS variable.
- The search bar was appearing above the feedback sidebar for some
  reason and it looked really bad, hack together a fix
  by setting a z-index.
- Only include the feedback button on the docs pages.

Instructions for how to upgrade the Push Feedback HTML/CSS
in the future:

npm install
rm -rf static/js/pushfeedback/
mv node_modules/pushfeedback/dist/pushfeedback static/js

Signed-off-by: Julia Evans <julia@jvns.ca>
@jvns
jvns requested a review from To1ne November 10, 2026 22:31
@jvns

jvns commented Nov 14, 2026

Copy link
Copy Markdown
Collaborator Author

I emailed the Push Feedback creator for some clarifications and he was very helpful. Updated the PR description with answers to some of the questions I had (it's possible to remove the email/screenshot fields if we want, there are no cookies)

I also asked if it's okay for us to host the JS/CSS code ourselves and they confirmed they don't make breaking API changes.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Collect feedback on docs

1 participant