Skip to content

Adds new docs and changelog for track recording in RealtimeKit #31106

Open
korinne wants to merge 9 commits into
productionfrom
korinne/updates-track-recording-docs
Open

Adds new docs and changelog for track recording in RealtimeKit #31106
korinne wants to merge 9 commits into
productionfrom
korinne/updates-track-recording-docs

Conversation

@korinne
Copy link
Copy Markdown
Contributor

@korinne korinne commented May 28, 2026

Summary

A redo of #31077 because Bonk went a little too crazy. Adds new documentation and changelog for recording specific participant audio tracks in RealtimeKit

ToxicityMax and others added 9 commits May 27, 2026 23:33
…cording.mdx

Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: korinne <korinne@users.noreply.github.com>
Co-authored-by: korinne <korinne@users.noreply.github.com>
Co-authored-by: korinne <korinne@users.noreply.github.com>
Co-authored-by: korinne <korinne@users.noreply.github.com>
@korinne korinne requested a review from swapnilmadavi May 28, 2026 11:24
@korinne korinne requested review from a team, ravindra-cloudflare and roerohan as code owners May 28, 2026 11:24
@cloudflare-docs-bot
Copy link
Copy Markdown

cloudflare-docs-bot Bot commented May 28, 2026

Review

✅ No style-guide issues found in commit c9d649c.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.

@github-actions
Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/realtime/ @cloudflare/product-owners, @cloudflare/realtime, @cloudflare/RealtimeKit, @roerohan, @ravindra-cloudflare

Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Posted 1 inline suggestion. 1 style issue to fix before merge.

  • MEDIUMsrc/content/docs/realtime/realtimekit/recording-guide/index.mdx:22 — Heading is phrased as a question. The style guide requires headings to be noun or verb phrases, never questions.

Out of scope: RealtimeKit docs consistently use <account_id> in curl blocks instead of the $ACCOUNT_ID shell-variable format required by the repo style guide. While the new pages match existing product conventions, consider a product-wide cleanup in a follow-up PR.

RealtimeKit can record the audio and video of multiple users in a meeting, as well as interactions with RealtimeKit plugins, in a single file using composite recording mode. RealtimeKit can also record separate participant audio tracks using [track recording](/realtime/realtimekit/recording-guide/track-recording/).

## How does RealtimeKit recording work?
## How does composite recording work
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings must be noun or verb phrases, never questions:

Suggested change
## How does composite recording work
## How composite recording works

@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented May 28, 2026

I reviewed PR #31106 by reading the diff and existing style guide, then posted a GitHub review with one inline suggestion to fix a heading phrased as a question ("How does composite recording work" should be "How composite recording works") and noted that the current labels are appropriate.

github run

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.

5 participants