How do I add ConveyThis to Help Scout Docs?

You add ConveyThis to Help Scout Docs with one short piece of code. It takes about five minutes, and you only do it once: new pages are translated automatically.

Step 1. Add your website in ConveyThis

  1. Log in to your ConveyThis dashboard and click Add Domain. If you just signed up, this setup opens by itself. No account yet? Create one for free.
  2. Under Website platform, choose Other (Javascript) and click Next.

Step 1 of Add a website: Which platform is your website built with?, with the Website platform list

  1. Enter your Website domain (for example example.com), your website’s current language and the Languages to translate into. Click Next.
  2. Choose how the addresses of your translated pages look. If you’re not sure, keep the default. You can change it later, see Customize your URLs. Click Next.
  3. On the Install step, click Copy next to the code.

The Install step: Copy the code, then add it to your site, with Check my site now on the right

Step 2. Add the code to Help Scout Docs

  1. In Help Scout, click Manage and choose Docs.
  2. Select the Docs site you want to translate.
  3. Click Custom Code in the left menu.
  4. Paste the code at the end of the Insert Code field and click Save.

Step 3. Check that it works

  1. Go back to the ConveyThis setup and click Check my site now. ConveyThis also checks every few seconds. When Code on the site shows that the code was found, translation starts.
  2. Open your website. The language switcher appears in the bottom right corner. Choose a language to see your translated page.

It can take a few minutes the first time. If you don’t see the switcher, clear your website’s cache and your browser cache, then reload the page.

Not the person who edits the website? On the Install step, enter your developer’s email and click Send. They get the code and the steps for your platform.

Good to know

  • Help Scout isn’t in the wizard’s list, so choose Other (Javascript). Enter your Docs address as the domain, for example docs.example.com.
  • Help Scout only offers a field for the page head. The code works there too.
  • To change the switcher’s look or position, go to Domains and open Settings on your website. See Change the switcher position.
  • To edit translations, see How do I edit my translations?
  • Translations don’t appear? See Translations are not displayed.