docs: add guides (#258)
This commit is contained in:
Carl-Gerhard Lindesvärd
committed by
GitHub
GitHub
parent
28692d82ae
commit
3d8a3e8997
@@ -3,9 +3,14 @@ title: Astro
|
||||
---
|
||||
|
||||
import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
import WebSdkConfig from '@/components/web-sdk-config.mdx';
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [Astro analytics guide](/guides/astro-analytics).
|
||||
</Callout>
|
||||
|
||||
## Installation
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -4,11 +4,16 @@ description: The Express middleware is a basic wrapper around Javascript SDK. It
|
||||
---
|
||||
|
||||
import Link from 'next/link';
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import { DeviceIdWarning } from '@/components/device-id-warning';
|
||||
import { PersonalDataWarning } from '@/components/personal-data-warning';
|
||||
|
||||
import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [Express analytics guide](/guides/express-analytics).
|
||||
</Callout>
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
|
||||
@@ -13,7 +13,7 @@ For most web projects, we recommend starting with one of these:
|
||||
|
||||
- **[Script Tag](/docs/sdks/script)** - The quickest way to get started, no build step required
|
||||
- **[Web SDK](/docs/sdks/web)** - For TypeScript support and more control
|
||||
- **[Next.js](/docs/sdks/nextjs)** - Optimized for Next.js applications
|
||||
- **[Next.js](/docs/sdks/nextjs)** - Optimized for Next.js applications | [Setup guide](/guides/nextjs-analytics)
|
||||
|
||||
## Web & Browser SDKs
|
||||
|
||||
@@ -38,12 +38,12 @@ For most web projects, we recommend starting with one of these:
|
||||
|
||||
### Frontend Frameworks
|
||||
|
||||
- **[Next.js](/docs/sdks/nextjs)** - Optimized for Next.js
|
||||
- **[Next.js](/docs/sdks/nextjs)** - Optimized for Next.js | [Setup guide](/guides/nextjs-analytics)
|
||||
- ✅ Server and client side tracking
|
||||
- ✅ App Router support
|
||||
- ✅ Automatic route tracking
|
||||
|
||||
- **[Astro](/docs/sdks/astro)** - Astro framework integration
|
||||
- **[Astro](/docs/sdks/astro)** - Astro framework integration | [Setup guide](/guides/astro-analytics)
|
||||
- ✅ Static and SSR support
|
||||
- ✅ Component-based tracking
|
||||
- ✅ Island architecture compatible
|
||||
@@ -51,10 +51,10 @@ For most web projects, we recommend starting with one of these:
|
||||
- **[React](/docs/sdks/react)** - React integration
|
||||
- 📝 Use Script Tag or Web SDK for now
|
||||
|
||||
- **[Vue](/docs/sdks/vue)** - Vue.js integration
|
||||
- **[Vue](/docs/sdks/vue)** - Vue.js integration | [Setup guide](/guides/vue-analytics)
|
||||
- 📝 Use Script Tag or Web SDK for now
|
||||
|
||||
- **[Remix](/docs/sdks/remix)** - Remix framework integration
|
||||
- **[Remix](/docs/sdks/remix)** - Remix framework integration | [Setup guide](/guides/remix-analytics)
|
||||
- 📝 Use Script Tag or Web SDK for now
|
||||
|
||||
- **Svelte** - Svelte integration
|
||||
@@ -71,12 +71,12 @@ For most web projects, we recommend starting with one of these:
|
||||
|
||||
## Server-Side SDKs
|
||||
|
||||
- **[Node.js (Express)](/docs/sdks/express)** - Express.js middleware
|
||||
- **[Node.js (Express)](/docs/sdks/express)** - Express.js middleware | [Setup guide](/guides/express-analytics)
|
||||
- ✅ Request tracking
|
||||
- ✅ Error tracking
|
||||
- ✅ Custom middleware support
|
||||
|
||||
- **[Python](/docs/sdks/python)** - Python SDK for server-side tracking
|
||||
- **[Python](/docs/sdks/python)** - Python SDK for server-side tracking | [Setup guide](/guides/python-analytics)
|
||||
- ✅ Thread-safe
|
||||
- ✅ Async support
|
||||
- ✅ Django and Flask compatible
|
||||
@@ -93,18 +93,18 @@ For most web projects, we recommend starting with one of these:
|
||||
|
||||
## Mobile SDKs
|
||||
|
||||
- **[React Native](/docs/sdks/react-native)** - Cross-platform mobile analytics
|
||||
- **[React Native](/docs/sdks/react-native)** - Cross-platform mobile analytics | [Setup guide](/guides/react-native-analytics)
|
||||
- ✅ iOS and Android support
|
||||
- ✅ Native performance
|
||||
- ✅ Offline support
|
||||
|
||||
- **[Swift](/docs/sdks/swift)** - Native iOS, macOS, tvOS, and watchOS SDK
|
||||
- **[Swift](/docs/sdks/swift)** - Native iOS, macOS, tvOS, and watchOS SDK | [Setup guide](/guides/swift-analytics)
|
||||
- ✅ Apple platform support
|
||||
- ✅ Swift Package Manager
|
||||
- ✅ Thread-safe API
|
||||
- ✅ Automatic lifecycle tracking
|
||||
|
||||
- **[Kotlin / Android](/docs/sdks/kotlin)** - Native Android SDK
|
||||
- **[Kotlin / Android](/docs/sdks/kotlin)** - Native Android SDK | [Setup guide](/guides/kotlin-analytics)
|
||||
- ✅ Android support
|
||||
- ✅ System information collection
|
||||
- ✅ Thread-safe API
|
||||
|
||||
@@ -9,6 +9,10 @@ import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
|
||||
The OpenPanel Kotlin SDK allows you to track user behavior in your Kotlin applications. This guide provides instructions for installing and using the Kotlin SDK in your project.
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [Kotlin analytics guide](/guides/kotlin-analytics).
|
||||
</Callout>
|
||||
|
||||
## Installation
|
||||
|
||||
<Callout type="warn">
|
||||
|
||||
@@ -7,9 +7,14 @@ import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
|
||||
import { DeviceIdWarning } from '@/components/device-id-warning';
|
||||
import { PersonalDataWarning } from '@/components/personal-data-warning';
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
import WebSdkConfig from '@/components/web-sdk-config.mdx';
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [Next.js analytics guide](/guides/nextjs-analytics).
|
||||
</Callout>
|
||||
|
||||
## Good to know
|
||||
|
||||
Keep in mind that all tracking here happens on the client!
|
||||
|
||||
@@ -8,6 +8,10 @@ import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
|
||||
The OpenPanel Python SDK allows you to track user behavior in your Python applications. This guide provides instructions for installing and using the Python SDK in your project.
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [Python analytics guide](/guides/python-analytics).
|
||||
</Callout>
|
||||
|
||||
## Installation
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -8,8 +8,13 @@ import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
import { DeviceIdWarning } from '@/components/device-id-warning';
|
||||
import { PersonalDataWarning } from '@/components/personal-data-warning';
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [React Native analytics guide](/guides/react-native-analytics).
|
||||
</Callout>
|
||||
|
||||
## Installation
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -9,6 +9,10 @@ import CommonSdkConfig from '@/components/common-sdk-config.mdx';
|
||||
|
||||
The OpenPanel Swift SDK allows you to integrate OpenPanel analytics into your iOS, macOS, tvOS, and watchOS applications.
|
||||
|
||||
<Callout>
|
||||
Looking for a step-by-step tutorial? Check out the [Swift analytics guide](/guides/swift-analytics).
|
||||
</Callout>
|
||||
|
||||
## Features
|
||||
|
||||
- Easy-to-use API for tracking events and user properties
|
||||
|
||||
Reference in New Issue
Block a user