add documentation
This commit is contained in:
12
apps/docs/src/components/device-id-warning.tsx
Normal file
12
apps/docs/src/components/device-id-warning.tsx
Normal file
@@ -0,0 +1,12 @@
|
||||
import Link from 'next/link';
|
||||
import { Callout } from 'nextra/components';
|
||||
|
||||
export function DeviceIdWarning() {
|
||||
return (
|
||||
<Callout>
|
||||
Read more about{' '}
|
||||
<Link href="/docs/device-id">device id and why you might want it</Link>.
|
||||
**We recommend not to but it's up to you.**
|
||||
</Callout>
|
||||
);
|
||||
}
|
||||
10
apps/docs/src/components/personal-data-warning.tsx
Normal file
10
apps/docs/src/components/personal-data-warning.tsx
Normal file
@@ -0,0 +1,10 @@
|
||||
import { Callout } from 'nextra/components';
|
||||
|
||||
export function PersonalDataWarning() {
|
||||
return (
|
||||
<Callout emoji="⚠️">
|
||||
Keep in mind that this is considered personal data. Make sure you have the
|
||||
users consent before calling this!
|
||||
</Callout>
|
||||
);
|
||||
}
|
||||
5
apps/docs/src/components/sdk-config.mdx
Normal file
5
apps/docs/src/components/sdk-config.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
- `url` - The url of the openpanel API or your self-hosted instance
|
||||
- `clientId` - The client id of your application
|
||||
- `trackScreenViews` - If true, the library will automatically track screen views
|
||||
- `trackOutgoingLinks` - If true, the library will automatically track outgoing links
|
||||
- `trackAttributes` - If true, the library will automatically track attributes
|
||||
Reference in New Issue
Block a user