Skip to content

docs: added realtime kit documentation #24293

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

Open
wants to merge 9 commits into
base: production
Choose a base branch
from

Conversation

roerohan
Copy link
Contributor

@roerohan roerohan commented Aug 11, 2025

Summary

This MR updates the documentation for Cloudflare Realtime. This includes the following changes:

  1. Moving the existing Realtime docs to "Realtime SFU"
  2. Introducing RealtimeKit, and documenting it in the root folder. There are more users for RealtimeKit than there are for Realtime, so this documentation occupies the parent folder.
  3. Creating the following pages for RealtimeKit documentation:
    3.1 Overview
    3.2 Introduction
    3.3 Concepts
    3.4 Getting Started
    3.5 Build your own UI

The plan is to move the RealtimeKit documentation from https://docs.realtime.cloudflare.com to this repository incrementally, so the changes in this MR might have links to https://docs.realtime.cloudflare.com. The goal is to move the introductory documentation for the RealtimeKit here in the first phase of changes.

Screenshots (optional)

This is what the root page for Realtime will look like once this PR is merged.
image

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@roerohan roerohan requested a review from a team as a code owner August 11, 2025 07:42
@roerohan roerohan marked this pull request as draft August 11, 2025 07:42
@roerohan roerohan force-pushed the feat-realtimekit-docs branch 2 times, most recently from 1a1c7e5 to 56e702d Compare August 11, 2025 10:20
@renandincer renandincer self-requested a review August 11, 2025 14:55
@renandincer
Copy link
Member

we're likely to have some broken links from moving the SFU contents to the SFU subdirectory, we might need to add some redirects

@roerohan
Copy link
Contributor Author

we're likely to have some broken links from moving the SFU contents to the SFU subdirectory, we might need to add some redirects

I'll get these fixed in the next few commits.

@roerohan roerohan force-pushed the feat-realtimekit-docs branch from adc54dc to 7329b56 Compare August 12, 2025 06:35
@roerohan roerohan marked this pull request as ready for review August 12, 2025 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants