@manototh/do11y 0.1.2 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/do11y.js +1028 -801
- package/dist/do11y.min.js +1 -1
- package/dist/instrumentation/index.js +1293 -0
- package/examples/do11y-config.example.js +2 -2
- package/package.json +29 -6
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Do11y is a documentation observability tool. It streams behavioral events from y
|
|
|
7
7
|
- Page views
|
|
8
8
|
- Scroll depth
|
|
9
9
|
- Link clicks
|
|
10
|
-
- Search
|
|
10
|
+
- Search usage
|
|
11
11
|
- Code-block copies
|
|
12
12
|
- Section reading time
|
|
13
13
|
- Tab switches
|
|
@@ -19,13 +19,13 @@ Do11y is built for humans and machines alike. It emits observability data design
|
|
|
19
19
|
|
|
20
20
|
Do11y is agent-native: it detects AI platform referrers (ChatGPT, Perplexity, Claude, Gemini, and others) so you can understand how agents and humans engage with your content differently.
|
|
21
21
|
|
|
22
|
-
The
|
|
22
|
+
The standalone artifact is a single dependency-free JavaScript file. The source is TypeScript. [rolldown](https://rolldown.rs) produces the built output.
|
|
23
23
|
|
|
24
24
|
## Privacy
|
|
25
25
|
|
|
26
26
|
Do11y collects anonymous usage data:
|
|
27
27
|
|
|
28
|
-
- No cookies. Do11y uses `sessionStorage`, which the browser clears when
|
|
28
|
+
- No cookies. Do11y uses `sessionStorage`, which the browser clears when the tab closes.
|
|
29
29
|
- No personally identifiable information (PII).
|
|
30
30
|
- No device fingerprinting.
|
|
31
31
|
- No cross-site tracking.
|
|
@@ -49,11 +49,11 @@ For other frameworks, use manual setup with custom selectors.
|
|
|
49
49
|
|
|
50
50
|
## Setup
|
|
51
51
|
|
|
52
|
-
Follow the [get started guide](https://docservable.com/get-started) to set up Do11y.
|
|
52
|
+
You can install Do11y as a standalone script or as an instrumentation layer on top of the official [OpenTelemetry Browser SDK](https://github.com/open-telemetry/opentelemetry-browser). Follow the [get started guide](https://docservable.com/get-started) to set up Do11y.
|
|
53
53
|
|
|
54
54
|
## Configuration
|
|
55
55
|
|
|
56
|
-
You can set
|
|
56
|
+
You can set options via meta tags or a configuration object. See the [configuration docs](https://docservable.com/configuration) for the full reference.
|
|
57
57
|
|
|
58
58
|
## Insights
|
|
59
59
|
|