Skip to content

Commit fa0dc9d

Browse files
authored
fix: move RealtimeKit docs into subfolder (#24481)
* fix: move RealtimeKit docs into subfolder * fix: update URLs * fix: added redirects for SFU * fix: repeated source url
1 parent bfc7af9 commit fa0dc9d

File tree

8 files changed

+59
-27
lines changed

8 files changed

+59
-27
lines changed

public/__redirects

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2357,4 +2357,8 @@
23572357
/realtime/demos /realtime/sfu/demos/ 302
23582358
/realtime/example-architecture /realtime/sfu/example-architecture/ 302
23592359
/realtime/pricing /realtime/sfu/pricing/ 302
2360-
/realtime/changelog /realtime/sfu/changelog/ 302
2360+
/realtime/changelog /realtime/sfu/changelog/ 302
2361+
2362+
/realtime/realtimekit/get-started /realtime/realtimekit/getting-started/ 302
2363+
/realtime/introduction /realtime/realtimekit/introduction 302
2364+
/realtime/concepts /realtime/realtimekit/concepts 302

src/content/docs/realtime/index.mdx

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,30 +26,17 @@ Cloudflare Realtime is a comprehensive suite of products designed to help you bu
2626

2727
### RealtimeKit
2828

29-
Cloudflare [RealtimeKit](/realtime/introduction) allows you to integrate programmable and easily customizable live video and voice into your web, mobile, and desktop applications. With just a few lines of code, you can enable live video communication, voice calls, and interactive live streaming.
29+
Cloudflare [RealtimeKit](/realtime/realtimekit/) allows you to integrate programmable and easily customizable live video and voice into your web, mobile, and desktop applications. With just a few lines of code, you can enable live video communication, voice calls, and interactive live streaming.
3030

31-
At its core, RealtimeKit is powered by the [Realtime SFU](/realtime/sfu), which efficiently routes video and audio streams between participants. RealtimeKit provides a set of user-friendly SDKs and APIs that act as a layer on top of the SFU, so you don't have to handle the complexities of media track management, peer management, and other intricate WebRTC-related tasks.
31+
At its core, RealtimeKit is powered by the [Realtime SFU](/realtime/sfu/), which efficiently routes video and audio streams between participants. RealtimeKit provides a set of user-friendly SDKs and APIs that act as a layer on top of the SFU, so you don't have to handle the complexities of media track management, peer management, and other intricate WebRTC-related tasks.
3232

3333
### Realtime SFU
3434

35-
The [Realtime SFU (Selective Forwarding Unit)](/realtime/sfu) is a powerful media server that efficiently routes video and audio streams between participants, and underpins the RealtimeKit. The Realtime SFU runs on [Cloudflare's global cloud network](https://www.cloudflare.com/network/) in hundreds of cities worldwide. For developers with WebRTC expertise, the SFU can be used independently to build highly custom applications that require full control over media streams. This is recommended only for those who want to leverage Cloudflare's network with their own WebRTC logic.
35+
The [Realtime SFU (Selective Forwarding Unit)](/realtime/sfu/) is a powerful media server that efficiently routes video and audio streams between participants, and underpins the RealtimeKit. The Realtime SFU runs on [Cloudflare's global cloud network](https://www.cloudflare.com/network/) in hundreds of cities worldwide. For developers with WebRTC expertise, the SFU can be used independently to build highly custom applications that require full control over media streams. This is recommended only for those who want to leverage Cloudflare's network with their own WebRTC logic.
3636

3737
### TURN Service
3838

39-
The [TURN service](/realtime/turn) is a managed service that acts as a relay for WebRTC traffic. It ensures connectivity for users behind restrictive firewalls or NATs by providing a public relay point for media streams.
40-
41-
<LinkButton variant="primary" href="/realtime/getting-started/">
42-
Get started
43-
</LinkButton>
44-
<LinkButton
45-
variant="secondary"
46-
href="https://dash.cloudflare.com/?to=/:account/realtime"
47-
>
48-
Realtime dashboard
49-
</LinkButton>
50-
<LinkButton variant="secondary" href="https://demo.realtime.cloudflare.com">
51-
RealtimeKit demo app
52-
</LinkButton>
39+
The [TURN service](/realtime/turn/) is a managed service that acts as a relay for WebRTC traffic. It ensures connectivity for users behind restrictive firewalls or NATs by providing a public relay point for media streams.
5340

5441
## Related products
5542

@@ -80,7 +67,7 @@ Cloudflare Stream lets you or your end users upload, store, encode, and deliver
8067

8168
<LinkTitleCard
8269
title="Use cases"
83-
href="/realtime/introduction#use-cases"
70+
href="/realtime/realtimekit/introduction#use-cases"
8471
icon="document"
8572
>
8673
Learn how you can build and deploy ambitious Realtime applications to
@@ -93,7 +80,7 @@ Cloudflare Stream lets you or your end users upload, store, encode, and deliver
9380
icon="x.com"
9481
>
9582
Follow @CloudflareDev on Twitter to learn about product announcements, and
96-
what is new in Cloudflare Workers.
83+
what is new in Cloudflare Realtime.
9784
</LinkTitleCard>
9885

9986
</CardGrid>

src/content/docs/realtime/concepts.mdx renamed to src/content/docs/realtime/realtimekit/concepts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This page explains the core concepts and terminology used in RealtimeKit.
99

1010
### Meeting
1111

12-
A **Meeting** is the fundamental communication channel in RealtimeKit. You can think of it like an event on your calendar - it's a persistent, long-lived container or "room" that serves as a blueprint for its [sessions](/realtime/concepts#session). Every session created for this meeting inherits the same base configuration, such as the title of the meeting and whether to automatically record the session when it starts. You add participants to the meeting, which grants them access to join a session of that meeting.
12+
A **Meeting** is the fundamental communication channel in RealtimeKit. You can think of it like an event on your calendar - it's a persistent, long-lived container or "room" that serves as a blueprint for its [sessions](/realtime/realtimekit/concepts/#session). Every session created for this meeting inherits the same base configuration, such as the title of the meeting and whether to automatically record the session when it starts. You add participants to the meeting, which grants them access to join a session of that meeting.
1313

1414
### Session
1515

@@ -33,7 +33,7 @@ A **Participant** is the server-side representation of a user within a session.
3333

3434
### Peer
3535

36-
A **Peer** is the client-side representation of a [participant](/realtime/concepts#participant) in a session. While the terms are sometimes used interchangeably, a peer represents a specific instance of a participant joining the meeting. For example, if a single user joins the same meeting from two different browser tabs, they will have the same participant ID (also referred to as a user ID) but two unique peer IDs.
36+
A **Peer** is the client-side representation of a [participant](/realtime/realtimekit/concepts/#participant) in a session. While the terms are sometimes used interchangeably, a peer represents a specific instance of a participant joining the meeting. For example, if a single user joins the same meeting from two different browser tabs, they will have the same participant ID (also referred to as a user ID) but two unique peer IDs.
3737

3838
### Stage
3939

File renamed without changes.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: RealtimeKit
3+
pcx_content_type: overview
4+
sidebar:
5+
order: 1
6+
head:
7+
- tag: title
8+
content: Overview
9+
---
10+
11+
import { Description, LinkButton } from "~/components";
12+
13+
<Description>
14+
15+
Integrate programmable, and easily customizable live video and voice into your web, mobile, and desktop applications with just a few lines of code.
16+
17+
</Description>
18+
19+
The RealtimeKit is a set of user-friendly SDKs and APIs that provides the fastest and simplest way to integrate a complete video and voice call interface into any application, allowing you to get started with just a few lines of code while still offering flexibility for customization.
20+
21+
Powerful yet simple to use, RealtimeKit is built on top of WebRTC and provides a set of user-friendly SDKs and APIs that act as a layer on top of the [Realtime SFU](/realtime/sfu/), so you don't have to handle the complexities of media track management, peer management, and other intricate WebRTC-related tasks.
22+
23+
Learn more about the [concepts](/realtime/realtimekit/concepts/) behind RealtimeKit, [how it works](/realtime/realtimekit/introduction/#how-realtimekit-works), and [use cases](/realtime/realtimekit/introduction/#use-cases).
24+
25+
<LinkButton variant="primary" href="/realtime/realtimekit/getting-started/">
26+
Get started
27+
</LinkButton>
28+
<LinkButton
29+
variant="secondary"
30+
href="https://dash.cloudflare.com/?to=/:account/realtime/kit"
31+
target="_blank"
32+
>
33+
RealtimeKit dashboard
34+
</LinkButton>
35+
<LinkButton
36+
variant="secondary"
37+
href="https://demo.realtime.cloudflare.com"
38+
target="_blank"
39+
>
40+
RealtimeKit demo app
41+
</LinkButton>

src/content/docs/realtime/introduction.mdx renamed to src/content/docs/realtime/realtimekit/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Build collaborative experiences for team meetings, online classrooms, or social
3131

3232
### Webinars
3333

34-
Webinars are one-to-many events designed for a presenter to share information with a large, interactive audience. Unlike group calls where all participants collaborate freely, webinars have distinct roles for presenters and viewers, managed through [presets](/realtime/concepts#presets). This structure, powered by WebRTC, is ideal for product demos, company all-hands, and live workshops, with features like chat, Q&A, and polls to engage the audience.
34+
Webinars are one-to-many events designed for a presenter to share information with a large, interactive audience. Unlike group calls where all participants collaborate freely, webinars have distinct roles for presenters and viewers, managed through [presets](/realtime/realtimekit/concepts/#presets). This structure, powered by WebRTC, is ideal for product demos, company all-hands, and live workshops, with features like chat, Q&A, and polls to engage the audience.
3535

3636
- **Product Demos:** Showcase your product to a large audience with live video and Q&A sessions.
3737
- **Company All-Hands:** Broadcast company-wide meetings to all your employees, no matter where they are.

src/content/docs/realtime/sfu/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Realtime SFU
33
pcx_content_type: overview
44
sidebar:
5-
order: 9
5+
order: 2
66
head:
77
- tag: title
88
content: Overview
@@ -31,4 +31,4 @@ Cloudflare Realtime SFU runs on [Cloudflare's global cloud network](https://www.
3131
</LinkButton>
3232
<LinkButton variant="secondary" href="https://github.com/cloudflare/orange">
3333
Orange Meets demo app
34-
</LinkButton>
34+
</LinkButton>

src/content/docs/realtime/turn/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: TURN Service
33
pcx_content_type: navigation
44
sidebar:
5-
order: 10
5+
order: 3
66
---
77

88
Separately from the SFU, Realtime offers a managed TURN service. TURN acts as a relay point for traffic between WebRTC clients like the browser and SFUs, particularly in scenarios where direct communication is obstructed by NATs or firewalls. TURN maintains an allocation of public IP addresses and ports for each session, ensuring connectivity even in restrictive network environments.
@@ -64,4 +64,4 @@ Each limit is for a single TURN allocation (single TURN user) and not account wi
6464

6565
:::
6666

67-
These limits are suitable for high-demand applications and also have burst rates higher than those documented above. Hitting these limits will result in packet drops.
67+
These limits are suitable for high-demand applications and also have burst rates higher than those documented above. Hitting these limits will result in packet drops.

0 commit comments

Comments
 (0)