Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: autocapture documentation #55

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@
"pages": [
"getting-started/sdk",
"getting-started/js-sdk",
"getting-started/react-sdk",
"getting-started/mobile-sdk"
"getting-started/react-sdk"
]
},
"getting-started/migration-guide",
Expand Down Expand Up @@ -78,6 +77,7 @@
},
"pages": [
"services/data-collection/overview",
"services/data-collection/autocapture",
"services/data-collection/data-layer",
"services/data-collection/page-event",
"services/data-collection/track-event",
Expand Down
2 changes: 1 addition & 1 deletion getting-started/js-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: JS SDK
description: Integrate the JavaScript SDK in a web application.
description: Manually integrate the JavaScript SDK in a web application.
icon: js
---

Expand Down
2 changes: 1 addition & 1 deletion getting-started/react-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ReactJS SDK
description: Integrate the Edgee SDK in a React app.
description: Manually integrate the Edgee SDK in a React app.
icon: react
---

Expand Down
34 changes: 29 additions & 5 deletions getting-started/sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,25 @@ communicating directly with the Edgee proxy so it can't be blocked.
convert the SDK into an inline `<script>` to improve performance
and to make sure that all client-side events are collected successfully.</Note>

### SDK integrations
### Easy Integration with Automatic SDK Injection

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:

- Eliminates the need for manual code integration
- Ensures proper SDK initialization across all pages
- Maintains optimal performance through automatic optimization
- Reduces implementation errors

<Frame caption="How to enable Automatic SDK Injection. Click on the image to zoom in.">
<img
src="/images/automatic-sdk-injection.png"
alt="Automatic SDK Injection"
/>
</Frame>

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.

### Manual SDK integrations

We provide SDKs for different frameworks and libraries.

Expand All @@ -40,13 +58,19 @@ Choose the one that fits your project:
<Card title="Edgee React Component" icon="react" href="/getting-started/react-sdk">
Use the React component to inject the Edgee SDK into a React application.
</Card>

<Card title="Mobile SDK" icon="react" href="/getting-started/mobile-sdk">
Integrate Edgee with a mobile application.
</Card>
</CardGroup>


### Autocapture

The Edgee SDK also supports autocapture, which is a feature that automatically captures events from your application.

To enable autocapture, you need to enable the feature in your project settings.
Don't hesitate to check the [Autocapture documentation](/services/data-collection/autocapture) for more information.




### Good to know: Testing Edgee locally

To test Edgee locally, you have two options:
Expand Down
Binary file added images/autocapture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/automatic-sdk-injection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
96 changes: 48 additions & 48 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
"links": "mintlify broken-links"
},
"dependencies": {
"mintlify": "^4.0.420"
"mintlify": "^4.0.423"
}
}
Loading