Article Feedback Widget

Add a β€œWas this article helpful? πŸ‘ πŸ‘Žβ€ prompt to the bottom of every documentation article. Votes are anonymous, deduplicated per visitor, and aggregated per article β€” so you can quickly see which pages confuse readers and which ones land well.

What your readers see

A small block appears at the bottom of every article:

Was this article helpful? πŸ‘ Yes Β Β  πŸ‘Ž No

After clicking, the widget thanks the reader. If you require a comment on negative votes, a short text box appears so they can tell you what was missing or wrong.

Setup

The widget is enabled by default for all docs sites β€” nothing to configure.

To disable it, or to ask for a comment after a πŸ‘Ž vote, add a feedback block under docs: in your .github/scitor.yaml:

docs:
  feedback:
    enabled: true                       # set to false to hide the widget
    require_comment_on_negative: false  # show a text box after πŸ‘Ž

Reviewing the feedback

Negative votes and reader comments are surfaced in the monthly support report (delivered via /generate-report), grouped by article so you can see which pages need attention first.

Privacy

  • No cookies, no logins, no personal data is stored.
  • A single visitor’s vote is counted once per article β€” repeated clicks are ignored.
  • Comments are stored only when the reader chooses to write one.

Configuration reference

Key Default Description
docs.feedback.enabled true Show or hide the widget on all articles
docs.feedback.require_comment_on_negative false Show a comment textarea after a πŸ‘Ž vote

Was this article helpful?

Scitor β€” Turn GitHub into your support platform