Documentation Insights
Understand how users are viewing your open-source documentation, web sites and more. Respect end-user privacy. Build with Insights.
By instrumenting your READMEs, documentation websites, tutorial pages, and other web properties, Scarf can show you which companies frequently view your documentation—providing access to potential customers for training or support.
You’ll gain insights into:
Which businesses are visiting your documentation pages.
Which locales they are coming from (geolocation data in aggregate).
Which docs pages are most frequently visited.
Documentation Insights lets you measure your project's web traffic in places where you can't run traditional JavaScript-enabled observability tools, and on sites that embed your project's content but don't share this information with you.
Frequently asked questions
Everything you need to know about Documentation Insights
You copy an <img> tag from Scarf into your project’s README, docs, or any other web property, and any time a user loads the image from us, Scarf will look up any business metadata associated with the address and surface that information to you (and only you) via your free Scarf account. Scarf does not store the IP address itself, so no personally identifying information is collected.
Head to your Scarf dashboard and locate the Documentation Insights Management section. Give your pixel(s) a name, and optionally attach it to a package you manage on Scarf. Click the "copy" button to copy the <img> tag to your clipboard, and then paste the tag into your project's README, docs, and any other web properties where you want to gather insights into who is using your documentation pages.
