> For the complete documentation index, see [llms.txt](https://docs.reo.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.reo.dev/integrations/input-sources/developer-insights/documentation.md).
# Documentation
### Overview
More often than not, **developers evaluate your product in incognito mode**. They read your docs, run installs, and test features on their own terms.
By the time that activity surfaces as a lead, they may have already evaluated you, built something in-house, or picked a competitor.
**Connecting your documentation to Reo.dev closes that gap.**
Once installed, Reo.dev identifies the developers and accounts behind your docs traffic, including the ones who never fill out a form. That activity flows into their account and developer profiles, segments, and alerts.
**GTM teams get a live view of who's evaluating your product and how they're engaging with your docs, instead of finding out after the deal has already moved on.**
The setup has 4 steps:
{% stepper %}
{% step %}
### [Add the URLs you want to track](#step-1-add-your-documentation-urls)
{% endstep %}
{% step %}
### [Mark high-intent pages for separate tracking (optional)](#step-2-configure-key-pages-optional)
{% endstep %}
{% step %}
### [Get your client ID and tracking snippet](#step-3-get-your-client-id-and-tracking-snippet)
{% endstep %}
{% step %}
### [Choose an installation method](#step-4-choose-the-installation-method)
*Based on how your documentation is built*
{% endstep %}
{% endstepper %}
***
### Step 1: Add your documentation URLs
1. From the left menu, navigate to **Settings → Integrations.**
2. Click **Configure** on the **Documentation** card.
3. Enter each documentation URL you want to track, exactly as it appears in your browser's address bar.
1. For example, `docs.reo.dev` for product documentation, or `developers.reo.dev` for developer documentation.
4. Click **Add New** to track more than one.
5. Give each URL a clear **Page Name**. You'll use it later to filter and segment your data.
{% hint style="info" %}
**Tip:** Use these pages to build a segment of developers or accounts interacting with a specific documentation site. The Page Name you set here becomes a filter when you create that segment.
{% endhint %}
***
### Step 2: Configure key pages (optional)
Pages like API references, troubleshooting guides, and installation docs often signal strong buying intent. We recommend tracking these separately so you can see their activity on its own.
This is on the same [**Configure screen as Step 1**](#step-1-add-your-documentation-urls)**,** in the **Add Key Pages (Optional)** section.
To track a key page:
1. Click **+ Add New** to add a row.
2. Enter its specific URL, exactly as it appears in your browser's address bar.
3. Assign it a unique Page Name.
#### **Tracking dynamic URLs using wildcards**
If your URLs include dynamic segments, like a project ID or org name, track every variation as one Key Page. Use `*` as a wildcard for the dynamic part.
For example, to track the journeys page across every project, set the URL to `/project/*/journeys`. Reo captures every URL that matches this pattern, no matter what replaces the `*`.
Wildcards can appear mid-URL too, like `abc.com/id/*/orgpage`. Skip trailing wildcards, like `abc.com/page/*`, since Reo already captures everything after the last `/`.
{% hint style="info" %}
**Tip:** You can create a segment to track accounts, developers, or buyers who visited these pages. The page name appears under the **Key Docs Pages filter** when you build that segment.
{% endhint %}
***
### Step 3: Get your client ID and tracking snippet
Every method below needs these two things. Get them once, then pick your method.
#### **What's a Client ID, and where do I find it?**
* Your Client ID is a unique key that connects this snippet to your Reo.dev account. Without it, Reo.dev has no way to tell which account the tracking data belongs to.
* The same ID works across every tracking type (Documentation, Website, Product, Forms), so reuse it if you've already copied it elsewhere.
* You can find your client ID on top of the Documentation page within the Reo product. Copy the client ID.
#### Copy the tracking code
* On the same page, under Step 3 (Install Tracking Pixel), you will find the tracking code.
* Copy the tracking snippet below, and replace `xxxxxxxxxx` with your Client ID.
```javascript
```
***
### Step 4: Choose the installation method
Once you have your client ID and the tracking code, all you have to do is install the tracking snippet using the method that matches how your documentation site is built.
**Choose from the following methods:**
{% columns %}
{% column %}
**If you can edit your documentation's HTML directly**
[Refer to Method 1](#method-1-paste-the-snippet) to paste the tracking snippet inside the header
{% endcolumn %}
{% column %}
**If you are using Google Tag Manager for your documentation**\
\
[Refer to Method 2](#method-2-google-tag-manager) and install using Google Tag Manager (GTM)
{% endcolumn %}
{% column %}
**If your documenation is built on npm-based JavaScript project**\
\
[Refer to Method 3](#method-3-npm-package) and install using NPM package
{% endcolumn %}
{% column %}
**If you are using Gitbook, Mintlify, Docusaurus, or Next.js**\
\
[Refer to Method 4](#method-4-direct-integration), and follow the guide for your respective platform
{% endcolumn %}
{% endcolumns %}
Still not sure? Ask whoever manages your documentation site's code.
***
### **Method 1: Paste the snippet**
Paste the snippet you copied above inside the `` tag of your documentation site. This is usually in the site's main template or layout file, the one that loads on every page (for example `header.html`, `_document.tsx`, or your theme's base layout).
If you're not sure where that is, ask whoever manages your site's code, or use one of the other methods below.
***
### **Method 2: Google Tag Manager**
Add the snippet above as a custom HTML tag in Google Tag Manager. See the [Google Tag Manager guide](https://docs.reo.dev/install-javascript-for-website-documentation-through-google-tag-manager) for setup steps.
***
### **Method 3: NPM package**
Install the Reo.dev NPM package if your documentation site is built with npm. See the [NPM package guide](https://docs.reo.dev/install-javascript-using-npm-package) for setup steps.
***
### **Method 4: Direct integration**
Connect directly through your documentation platform:
* [Gitbook](https://docs.reo.dev/integrations/developer-docs/gitbook)
* [Mintlify](https://docs.reo.dev/integrations/developer-docs/mintlify)
* [Docusaurus](https://docs.reo.dev/integrations/developer-docs/docusaurus)
* [Next.js applications](https://docs.reo.dev/integrations/developer-docs/next-applications)
***
### Troubleshooting
#### **Verify the snippet is installed**
The fastest way: on the Documentation configuration page (**Settings → Integrations → Documentation → Configure**), click **Check status** in the top-right corner. It tells you whether Reo.dev is receiving data from your site.
To check manually instead:
1. Open your documentation page
2. Right-click anywhere on the page and select **Inspect** to open developer tools
3. In the **Network tab**, search for `reo` and check if the network calls are being registered (status code: 200)
***
### Error scenarios
#### **1. The script doesn't load**
The tracking snippet only runs after it downloads successfully from the Reo.dev CDN. A failed download doesn't break your page, it just means that visit isn't tracked. It also won't throw visible errors in the browser console, since the script runs inside a try-catch block with logging disabled. No action is needed. Use the [verification steps above](#verify-the-snippet-is-installed) if you want to confirm the snippet is live.
#### **2. Reo tokens are deleted**
If all Reo tokens are deleted, the most recent event may fail to send. Tracking recovers on its own, and subsequent calls work normally. No action is needed.
#### **3. Avoid duplicate installs**
Don't install the tracking snippet more than once on the same page. Multiple copies can conflict with each other.
Still stuck? Contact your Customer Success Manager on Slack, or email [**support@reo.dev**](mailto:support@reo.dev).
***
### CSP requirements
If your site enforces a Content Security Policy (CSP), allow these domains. This is usually set in your site's HTTP response headers or a CSP meta tag, ask whoever manages your hosting if you're not sure where.
* `script-src `
* `connect-src `
For cookies and data handling, see the [cookie management guide](https://docs.reo.dev/integrations/tracking-beacon/reo.dev-javascript-cookies-and-consent-guide).
***
### FAQs
* **Is the tracking script safe to install?**\
Yes, it's been tested to rule out vulnerabilities or risks, and all data is transmitted over HTTPS.
* **Does it use external dependencies?**\
Yes, a small number of third-party libraries. These are checked for vulnerabilities.
* **Does it collect personal information (PII)?**\
No, it collects anonymous data only, such as browser information, page views, and click events, and never collects non-consented PII.
* **Will it slow down my page?**\
No, it loads asynchronously, so it doesn't block your page from rendering, and it's built to have minimal impact on load time.
* **Which browsers and devices does it support?**\
Chrome, Firefox, Safari, Edge, and Brave, on both desktop and mobile.
* **Will visitors notice any change to the site?**\
No, it runs in the background and doesn't add any visible or intrusive elements.
* **What happens if the script hits an error?**\
It fails safely. Built-in safeguards stop it from interrupting your site's core functionality.
* **Does it hold up under high traffic?**\
Yes, it's built to keep performing as your site's traffic grows.
* **Is it compliant with GDPR and CCPA?**\
Yes, in how it handles data privacy and user consent.
* **Does it track when someone copies a command from my docs?**\
Yes, by default. Reo.dev tracks copied text, package manager commands, and CLI commands, since copying an install command is one of the strongest signals that a developer is about to try your product. If you'd rather turn this off, add the `dnt: ["copy"]` flag when you initialize Reo.
* **Can I track versioned or multi-language documentation?**\
There's no dedicated versioning feature, but you can track each version or language separately. Add each one as its own URL in Step 1, for example `docs.example.com/v1` and `docs.example.com/v2`, or `docs.example.com/en` and `docs.example.com/fr`.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.reo.dev/integrations/input-sources/developer-insights/documentation.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
