How to add a feedback widget to a Docusaurus docs site

Where the Bopmigo line goes in a Docusaurus docs site (docusaurus.config.js, under scripts), with code you can copy, and how to test it locally.

Short answer: add the script to the scripts list in docusaurus.config.js. Build and deploy, and readers can report problems in your docs.

Add it to Docusaurus

1. 1

   Create your Bopmigo project

   Sign up at bopmigo.com, choose Website, and add your Docusaurus address. Copy your line from Install snippet:

   HTMLCopy

   <script src="https://bopmigo.com/widget.js"
     data-project="YOUR-PROJECT-ID" defer></script>

2. 2

   Open it

   Open docusaurus.config.js.

3. 3

   Add your line

   Add the entry under scripts.

   ConfigCopy

   // docusaurus.config.js
   export default {
     // ...
     scripts: [
       {
         src: 'https://bopmigo.com/widget.js',
         'data-project': 'YOUR-PROJECT-ID',
         defer: true,
       },
     ],
   };

4. 4

   Go live

   Build and deploy.

5. 5

   Send yourself a test

   Open the live page, choose Feedback and send a short report. It arrives in your Bopmigo inbox (and by email, if you turned that on). Reply, then open Feedback again to see your answer.

Docusaurus tips

• Docs feedback works best with a short question, so readers can say what was unclear on the page they’re reading.
• Each report notes the docs page it came from.
• Add your docs domain to the project in Bopmigo.

Single-page apps and client-side routing

Load the script once in the root layout, not per page. Bopmigo notes the page people are on when they report, including after client-side navigation, so there’s nothing to re-run on route changes.

Testing locally

Add your local address (for example http://localhost:3000) to the project in Bopmigo, alongside your production address. Reports are only accepted from addresses you list.

What Docusaurus users tend to report

• Code samples that no longer work with the current API.
• Steps that assume knowledge the page doesn’t give.
• Version selector confusion.

Your first week

1. 1

   Day 1: test locally and in production

   Send a report from localhost and from your live site, and check both arrive in the same inbox.

2. 2

   Days 2 to 5: identify signed-in users

   Pass the user ID and any useful context, such as plan or account, so each report says who it came from.

3. 3

   Days 6 and 7: route reports to your tracker

   Copy reports that need code changes into your issue tracker, and reply when the fix ships.

Questions

More: all install guides · website options · install with a coding agent