Skip to content

Commit 8555904

Browse files
committed
feat: autocapture documentation
1 parent 723045e commit 8555904

File tree

9 files changed

+205
-58
lines changed

9 files changed

+205
-58
lines changed

docs.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@
4545
"pages": [
4646
"getting-started/sdk",
4747
"getting-started/js-sdk",
48-
"getting-started/react-sdk",
49-
"getting-started/mobile-sdk"
48+
"getting-started/react-sdk"
5049
]
5150
},
5251
"getting-started/migration-guide",
@@ -78,6 +77,7 @@
7877
},
7978
"pages": [
8079
"services/data-collection/overview",
80+
"services/data-collection/autocapture",
8181
"services/data-collection/data-layer",
8282
"services/data-collection/page-event",
8383
"services/data-collection/track-event",

getting-started/js-sdk.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: JS SDK
3-
description: Integrate the JavaScript SDK in a web application.
3+
description: Manually integrate the JavaScript SDK in a web application.
44
icon: js
55
---
66

getting-started/react-sdk.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ReactJS SDK
3-
description: Integrate the Edgee SDK in a React app.
3+
description: Manually integrate the ReactJS SDK in a React app.
44
icon: react
55
---
66

getting-started/sdk.mdx

+29-5
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,25 @@ communicating directly with the Edgee proxy so it can't be blocked.
2626
convert the SDK into an inline `<script>` to improve performance
2727
and to make sure that all client-side events are collected successfully.</Note>
2828

29-
### SDK integrations
29+
### Easy Integration with Automatic SDK Injection
30+
31+
The simplest way to integrate Edgee into your website is by using our Automatic SDK Injection feature. When enabled, Edgee will automatically inject the SDK into your web pages without requiring any manual code changes. This feature:
32+
33+
- Eliminates the need for manual code integration
34+
- Ensures proper SDK initialization across all pages
35+
- Maintains optimal performance through automatic optimization
36+
- Reduces implementation errors
37+
38+
<Frame caption="How to enable Automatic SDK Injection. Click on the image to zoom in.">
39+
<img
40+
src="/images/automatic-sdk-injection.png"
41+
alt="Automatic SDK Injection"
42+
/>
43+
</Frame>
44+
45+
You can enable this feature in your project settings with a simple toggle. If you prefer manual control, you can still integrate the SDK manually using the methods described below.
46+
47+
### Manual SDK integrations
3048

3149
We provide SDKs for different frameworks and libraries.
3250

@@ -40,13 +58,19 @@ Choose the one that fits your project:
4058
<Card title="Edgee React Component" icon="react" href="/getting-started/react-sdk">
4159
Use the React component to inject the Edgee SDK into a React application.
4260
</Card>
43-
44-
<Card title="Mobile SDK" icon="react" href="/getting-started/mobile-sdk">
45-
Integrate Edgee with a mobile application.
46-
</Card>
4761
</CardGroup>
4862

4963

64+
### Autocapture
65+
66+
The Edgee SDK also supports autocapture, which is a feature that automatically captures events from your application.
67+
68+
To enable autocapture, you need to enable the feature in your project settings.
69+
Don't hesitate to check the [Autocapture documentation](/services/data-collection/autocapture) for more information.
70+
71+
72+
73+
5074
### Good to know: Testing Edgee locally
5175

5276
To test Edgee locally, you have two options:

images/autocapture.png

424 KB
Loading

images/automatic-sdk-injection.png

142 KB
Loading

package-lock.json

+48-48
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
"links": "mintlify broken-links"
55
},
66
"dependencies": {
7-
"mintlify": "^4.0.420"
7+
"mintlify": "^4.0.423"
88
}
99
}

0 commit comments

Comments
 (0)