OpenRefine / OpenRefine/openrefine.org

[Feature] : Documentation Feedback Widget

Open
#519 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
161
Forks
142
Avg merge
6h 10m
Merged PRs (30d)
9

Description

Problem

Documentation is only as good as its maintenance. Currently, there is no direct way for a user to signal that a specific page is outdated, unclear, or broken, other than opening a GitHub issue (which has high friction).

Proposed Solution

Implement a "Was this page helpful?" feedback widget at the bottom of every documentation page.

Key Features
  1. Simple Binary Feedback:

    • "👍 Yes" / "👎 No" buttons at the bottom of the docs layout.
  2. Optional Context:

    • If "No" is clicked, optionally expand a small text area asking "What went wrong?" (e.g., "Outdated", "Confusing", "Example didn't work").
  3. Analytics Integration:

    • Send this event data to the existing analytics provider (Google Analytics or similar, if configured) or log it to a service like Netlify Forms (since the site is hosted on Netlify).
  4. GitHub Issue Link:

    • Provide a "Report an issue on GitHub" link next to the feedback widget for more detailed bug reports.

Technical Feasibility

  • Implementation: Docusaurus Swizzle feature can be used to wrap the DocItem component or append to the DocItemFooter.
  • Backend: Netlify Forms is a great zero-config backend for this since netlify.toml is present in the repo.
  • Scope: ~2 weeks.
    • Week 1: Swizzle DocItemFooter component and build UI.
    • Week 2: Integrate with Netlify Forms or Analytics API and style it to match the theme.

Value

Provides a passive, low-friction channel for improving documentation quality, essential for complex tools like OpenRefine.

Contributor guide

No contributing guide indexed for this repository

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

Start by locating the Docusaurus DocItemFooter swizzle entry point and reading netlify.toml. Check whether an analytics provider is configured before deciding between analytics and Netlify Forms. Done means every documentation page has the binary feedback UI, optional context for negative feedback, and a GitHub issue link with the chosen submission path working.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.