Skip to content

feat: realtime kit docs #23251

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

Draft
wants to merge 10 commits into
base: production
Choose a base branch
from
75 changes: 75 additions & 0 deletions src/content/docs/realtime/realtimekit/guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Guides
pcx_content_type: overview
sidebar:
order: 1
head:
- tag: title
content: Overview
---

import ProductSection from "src/content/docs/realtime/realtimekit/partials/_product-section.mdx";
import {
CardGrid,
Card,
LinkCard,
LinkTitleCard,
} from "@astrojs/starlight/components";

<ProductSection></ProductSection>

### Capabilities

Learn how to use key features of RealtimeKit, such as recording, breakout rooms, webinars, and more.

<CardGrid>
<LinkCard
href="/realtime/realtimekit/guides/capabilities/recording/recording-overview"
title="Recording"
description="Understand RealtimeKit's recording capabilities and record audio, video, whiteboard and other custom elements"
icon="record"
/>
<LinkCard
href="/realtime/realtimekit/guides/capabilities/webinar/intro-webinar"
title="Webinar"
description="Leverage RealtimeKit's Webinar feature for one-to-many events with larger audiences."
icon="webinar"
/>
<LinkCard
href="/realtime/realtimekit/guides/capabilities/webhooks/webhooks-overview"
title="Webhooks & Events"
description="Utilize webhooks to push real-time updates to your server."
icon="webhooks"
/>
<LinkCard
href="/realtime/realtimekit/guides/capabilities/breakoutroom/introduction-breakout-rooms"
title="Breakout Rooms"
description="Facilitate focused discussions and collaboration with breakout rooms."
icon="breakout-rooms"
/>
<LinkCard
href="/realtime/realtimekit/guides/capabilities/misc/embed"
title="No Code Integration"
description="Integrate RealtimeKit into your project using an iFrame, eliminating the need for SDKs."
icon="no-code"
/>
<LinkCard
href="/realtime/realtimekit/guides/capabilities/chat/export-chat-dump"
title="Export chat"
description="Retrieve all chat messages of a RealtimeKit meeting through the REST API"
icon="chat"
/>
</CardGrid>

### Working with RealtimeKit APIs

Learn the basics of working with RealtimeKit's REST APIs.

<CardGrid>
<LinkCard
href="/realtime/realtimekit/guides/rest-apis/quickstart"
title="REST APIs"
description="Understand how our REST APIs work and how to get started with them"
icon="rest-api"
/>
</CardGrid>
48 changes: 48 additions & 0 deletions src/content/docs/realtime/realtimekit/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: RealtimeKit
pcx_content_type: overview
sidebar:
order: 1
head:
- tag: title
content: Overview
---

import { Description, LinkButton, CardGrid, LinkCard } from "~/components";

<Description>

</Description>

Integrate programmable, and easily customizable live video and voice into your web, mobile, and desktop applications with just a few lines of code.

<CardGrid>
<LinkCard
href="/realtime/realtimekit/guides/live-video/intro-video-conf"
title="Live Video Calls"
description="Enable live video communication within your application using WebRTC. Perfect for education, telemedicine, social networks and gaming"
icon="video"
/>
<LinkCard
href="/realtime/realtimekit/guides/voice-conf/intro-voice-conf"
title="Voice Calls"
description="Incorporate high-quality real-time audio into your application using WebRTC. Build voice calls, audio conferences, voice chats in games and more"
icon="mic"
/>
<LinkCard
href="/realtime/realtimekit/guides/livestream/livestream-overview"
title="Interactive Live Streaming"
description="Integrate highly scalable live video broadcasting capabilities into your app using HLS, ideal for apps that involve streaming webinars, sports or live events"
icon="live"
/>
</CardGrid>

<LinkButton variant="primary" href="/realtime/realtimekit/guides/">
Guides
</LinkButton>
<LinkButton
variant="secondary"
href="https://dash.realtime.cloudflare.com/dashboard"
>
RealtimeKit Dashboard
</LinkButton>
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { Description, LinkButton } from "~/components";
import {
CardGrid,
Card,
LinkCard,
LinkTitleCard,
} from "@astrojs/starlight/components";

<Description>
Learn how to integrate live video and voice, live stream, and chat experiences
into your product.
</Description>

### Quickstart

<CardGrid>
<LinkCard
href="/realtime/realtimekit/guides/live-video/intro-video-conf"
title="Live Video"
description="Enable live video communication within your application using WebRTC. Perfect for education, telemedicine, social networks and gaming."
icon="video-camera"
/>
<LinkCard
href="/realtime/realtimekit/guides/voice-conf/intro-voice-conf"
title="Voice Conferencing"
description="Integrate reliable voice calling experiences into your product."
icon="phone"
/>
<LinkCard
href="/realtime/realtimekit/guides/livestream/livestream-overview"
title="Interactive Live Streaming"
description="Get started with interactive livestreaming and broadcast to a large audience."
icon="broadcast"
/>
</CardGrid>