Skip to content

Introduction

Do11y is a documentation observability solution from Axiom. It turns documentation usage into machine data by streaming behavioral events from your docs site to Axiom in real time.

Do11y is built for humans and machines alike. It emits observability data that is easy to read in the Axiom UI and easy to query programmatically.

Do11y is agent-native. It detects AI platform referrers so you can understand how agents and humans engage with your content differently.

The runtime artifact is a single dependency-free JavaScript file built from TypeScript with rolldown. Load it from a CDN or self-host it.

Why documentation observability

General web analytics tools were designed for marketing sites and e-commerce funnels. Their model is based on the visitor arriving, viewing pages, clicking links, converting or leaving. Applied to documentation, that model tends to answer the wrong questions.

Technical writers, information architects, and documentation engineers need different signals. Did users read the section they were looking for, or scroll past it? Which code example did they copy? When a user opens search immediately after landing on a page, is the content failing them? Those questions require events that general analytics tools don't track.

Do11y tracks documentation-specific behavior automatically. Section reading time records which headings stayed in the viewport long enough to be read, not just whether the user was on the page. Code-block copies capture which example, in which language, in which section. Tab switches tell you which framework or language your audience actually uses. Table of contents (TOC) usage can be a hint for page organization as high click rates can signal that a page is too long or poorly structured.

General analytics tools also lock you into their reporting interface. Do11y sends raw events to Axiom, where you query them with full flexibility. You can ask questions that a prebuilt dashboard would never surface, such as which sessions copied a code block and then exited without navigating further.

The privacy profile is different too. Tools that rely on cookies or build persistent user profiles require a GDPR/CCPA consent banner. Do11y uses sessionStorage, collects no personal data, and does no fingerprinting, which removes that compliance overhead for most teams. You usually don't need a GDPR/CCPA consent banner for using Do11y. If your organization has specific compliance obligations, verify with your legal team.

General analytics tools are fine if your team's primary question is "how do people find our docs site?" Do11y doesn't replace these tools for marketing-level traffic analysis. But if you're looking for signals about how users actually use your docs and whether they're able to achieve their goals, Do11y is a great fit.

Events

Do11y streams the following behavioral events:

EventDescription
Page viewsEvery page load and SPA navigation, with referrer and AI platform classification.
Scroll depthHow far down the page users actually scroll.
Link clicksInternal links, external links, anchor links, and email links.
Search queriesWhen users open the search dialog.
Code-block copiesWhich code blocks users copy and in which language.
Section reading timeHow long each heading stays in the viewport.
Tab switchesWhich code language or framework tab users select.
TOC usageWhich table of contents entries users click.
Feedback"Was this helpful?" widget responses.
Expand/collapseInteractions with <details> elements and accordions.

These events are specific to how documentation is used. Knowing which sections users actually read, which code examples they copy, and where they stop engaging gives you signal that general web analytics tools don't surface.

Privacy

Do11y collects anonymous usage data with no impact on user privacy:

  • No cookies. Do11y uses sessionStorage, which the browser clears when it closes.
  • No personally identifiable information (PII).
  • No device fingerprinting.
  • No cross-site tracking.

Because Do11y uses no cookies and collects no personal data, it doesn't trigger consent requirements under GDPR's cookie rules or CCPA's personal information provisions. You usually don't need a GDPR consent banner for using Do11y. If your organization has specific compliance obligations, verify with your legal team.

Supported frameworks

Do11y supports the latest versions of the following documentation frameworks out of the box:

FrameworkInstall guide
MintlifyInstall on Mintlify
DocusaurusInstall on Docusaurus
NextraInstall on Nextra
MkDocs MaterialInstall on MkDocs Material
VitePressInstall on VitePress

For other frameworks, use manual setup.

Released under the MIT License.