Documentation

Reo.Dev can track developers who access your documentation to analyze their interactions and transform this data into actionable insights for your sales funnel. All you have to do is simply add the JavaScript code generated by Reo.Dev on relevant sections of your documentation.

Step 1: Configure Documentation URL

1. Add the documentation URLs you want to track. You can choose to add multiple base and sub-domain URLs by clicking on ‘Add New’.

1. Add a Page Name for each base URL

Once added, you can create a Segment to view accounts/developers/buyers interacting with each documentation site. The page name will appear under the ‘Key Docs’ filter while creating segments.

Step 2: Add Key Pages

This is an optional step. But we highly recommended adding your high-intent pages e.g, Troubleshooting, API Reference, Installation Guides as key pages so you can track activities on these pages separately.

1. Add URLs of specific doc pages you want to track activities on

1. Add a Page Name for each URL

You can create a Segment to track accounts/developers/buyers who visited those Pages. The page name will appear under Key Docs Pages filter while creating segments.

Step 3: Install Tracking Pixel on your Documentation

Copy the Javascript code snippet and paste it in the <header> of your site

Here are few more ways you can install JavaScript on documentation pages:

1. Using Google Tag Manager. Here’s the setup guide.

2. Using NPM Package. Here’s the setup guide.

For 3rd party documentation software:

• Gitbook

• Mintlify

• Docusaurus

Error Scenarios

• Script initiation

  Script initiation has been modified to rely on code initiation only on successful callback post download from CDN. So it will only initiate if successfully downloaded. In case the download fails, the javascript won’t get enabled but this eliminates the likelihood of an error scenario of page breaking.

• API failure on token delete

  On deletion of all Reo tokens, the most recent event tracking data will likely fail, but subsequent API calls will work fine.

• Any inadvertent code failure on JavaScript

  This should not be an issue since the code is wrapped in a try-catch block, the console may throw errors, which won’t be visible even on the console since logger would be disabled on the script.

Cookie Management and Compliance

To learn more about Reo.Dev's cookie usage, categorization, and best practices for implementation, refer to this guide.

Content Security Policy (CSP) Considerations

If your website uses a strict Content Security Policy (CSP), you may need to update it to allow our script to load and execute correctly. Please ensure the following directives are updated to include our domains:

Required CSP Directives Required CSP Directives Copy

script-srchttps://static.reo.dev;connect-srchttps://api.reo.dev;