Skip to content

docs(realtimekit): added realtimekit best practices around simulcast & bandwidth, fixed index order & demo app#31393

Open
ravindra-cloudflare wants to merge 2 commits into
productionfrom
realtimekit-best-practices
Open

docs(realtimekit): added realtimekit best practices around simulcast & bandwidth, fixed index order & demo app#31393
ravindra-cloudflare wants to merge 2 commits into
productionfrom
realtimekit-best-practices

Conversation

@ravindra-cloudflare

Copy link
Copy Markdown
Contributor

Summary

  1. Added Best Practices for RealtimeKit product around Simulcast, FPS, and other video resolution.
  2. Fixed page index
  3. Replaced legacy dashboard screenshots with newer one. Fixed the demo app link.

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 change adheres to the documentation style guide.
  • 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.

@ravindra-cloudflare ravindra-cloudflare requested review from a team and roerohan as code owners June 11, 2026 11:26
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Review

Reviewing new changes (commit 63dbbde)…


⚠️ 1 warning and 3 suggestions found in commit 0fd97a3.

Warnings (1)
File Issue
realtime/realtimekit/sdk-selection.mdx line 15 Remove contractions — Line contains "haven't" Fix: Change to "If you have not already"
Suggestions (3)
File Issue
realtime/realtimekit/best-practices/video-and-simulcast.mdx line 90 If a bullet list has fewer than three items, consider writing as prose instead. — Only two items in the bullet list under 'Pinned speaker with gallery' Fix: Rewrite the two list items as prose or add more items if relevant.
realtime/realtimekit/best-practices/video-and-simulcast.mdx line 123 If a bullet list has fewer than three items, consider writing as prose instead. — Only two items in the bullet list under 'Turn off simulcast when:' Fix: Rewrite the two list items as prose or add more items if relevant.
realtime/agents/getting-started.mdx line 264 Use 'select' instead of 'click' — Click on the Join icon next to the meeting Fix: Replace 'Click' with 'Select'
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
* @cloudflare/product-owners
/src/content/docs/realtime/ @cloudflare/product-owners, @cloudflare/realtime, @cloudflare/RealtimeKit, @roerohan, @ravindra-cloudflare

@hshandilya-cloudflare hshandilya-cloudflare left a comment

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.

LGTM

@ask-bonk ask-bonk Bot added content:new Request for new/missing content documentation Documentation edits labels Jun 11, 2026

@ask-bonk ask-bonk Bot left a comment

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.

Posted 1 inline suggestion.

Comment thread src/content/docs/realtime/agents/getting-started.mdx Outdated
@ask-bonk

ask-bonk Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Reviewed PR #31393 — applied labels (product:realtime, content:new, documentation) and posted 1 inline suggestion.

What the PR changes

  • New docs: Adds a best-practices section under RealtimeKit with guidance on video resolution, simulcast, and frame rate for different layouts (1:1 calls, podcasts, group grids, webinars, screen sharing).
  • Sidebar fixes: Bumps sidebar.order on several RealtimeKit pages to make room for the new best-practices entry.
  • Demo/dashboard link updates: Replaces legacy demo.realtime.cloudflare.com links with examples.realtime.cloudflare.com across index.mdx, faq.mdx, sdk-selection.mdx, and getting-started.mdx.
  • Screenshots: Replaces outdated dashboard screenshots in public/images/realtime-agents/.

Issues found

  • MEDIUM src/content/docs/realtime/agents/getting-started.mdx line 264: The PR touched this line but preserved a pre-existing style issue. It says "Click on the `Join` icon" — the style guide requires select (not click) for UI interactions, and icon/button labels should be bold, not monospace. I posted an inline suggestion to fix this.

Out-of-scope note

  • The image paths in getting-started.mdx reference public/images/... rather than root-relative /images/.... This is pre-existing across the repo, but worth fixing in a follow-up since the PR is already updating those images.

github run

@github-actions

Copy link
Copy Markdown
Contributor

Preview URL: https://63dbbdea.preview.developers.cloudflare.com
Preview Branch URL: https://realtimekit-best-practices.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/realtime/realtimekit/best-practices/video-and-simulcast/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/best-practices/video-and-simulcast/
https://developers.cloudflare.com/realtime/realtimekit/best-practices/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/best-practices/
https://developers.cloudflare.com/realtime/agents/getting-started/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/agents/getting-started/
https://developers.cloudflare.com/realtime/realtimekit/faq/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/faq/
https://developers.cloudflare.com/realtime/realtimekit/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/
https://developers.cloudflare.com/realtime/realtimekit/legal/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/legal/
https://developers.cloudflare.com/realtime/realtimekit/pricing/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/pricing/
https://developers.cloudflare.com/realtime/realtimekit/release-notes/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/release-notes/
https://developers.cloudflare.com/realtime/realtimekit/rest-api-reference/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/rest-api-reference/
https://developers.cloudflare.com/realtime/realtimekit/sdk-selection/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/sdk-selection/
https://developers.cloudflare.com/realtime/realtimekit/webhooks/ https://realtimekit-best-practices.preview.developers.cloudflare.com/realtime/realtimekit/webhooks/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:new Request for new/missing content documentation Documentation edits product:realtime size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants