Skip to content

docs(realtimekit): updated api reference as per latest core sdk - #32158

Merged
ravindra-cloudflare merged 1 commit into
productionfrom
realtimekit/update-sdk-reference
Jul 20, 2026
Merged

docs(realtimekit): updated api reference as per latest core sdk#32158
ravindra-cloudflare merged 1 commit into
productionfrom
realtimekit/update-sdk-reference

Conversation

@ravindra-cloudflare

Copy link
Copy Markdown
Contributor

Summary

Core SDK reference were not updated for a long time and went out of sync. Updating the SDK reference.

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 July 20, 2026 10:16
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review

⚠️ 1 warning found in commit 4d5d7ee.

Fix in your agent
Fix the following review findings in PR #32158 (https://github.com/cloudflare/cloudflare-docs/pull/32158).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, fix all legitimate findings. For any you decide to skip,
post a comment on this PR with the finding ID and your reasoning.

---

## Code Review

### Warnings (1)

#### CR-47a9bee826db · Misleading variable name in code example
- **File:** `src/content/docs/realtime/realtimekit/core/api-reference/RTKParticipant.md` line 17
- **Issue:** `participant4` is assigned the result of `.filter()`, which returns an array of participants, but the singular variable name implies a single `RTKParticipant` instance.
- **Fix:** Rename the variable to a plural name such as `johnParticipants`, or use `.find((p) => p.name === 'John')` if the intent is to show selecting a single participant.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

Warnings (1)
File Issue
realtime/realtimekit/core/api-reference/RTKParticipant.md line 17 Misleading variable name in code exampleparticipant4 is assigned the result of .filter(), which returns an array of participants, but the singular variable name implies a single RTKParticipant instance. Fix: Rename the variable to a plural name such as johnParticipants, or use .find((p) => p.name === 'John') if the intent is to show selecting a single participant.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues found.

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.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. Stops if there are conflicts and reports which files conflict.
/rebaseWithConflicts Rebases against production and attempts to resolve conflicts automatically using AI. Stops with an explanation if confidence is not high enough.

@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/docs/realtime/ @cloudflare/product-owners, @cloudflare/realtime, @cloudflare/RealtimeKit, @roerohan, @ravindra-cloudflare

@github-actions

Copy link
Copy Markdown
Contributor

@ravindra-cloudflare
ravindra-cloudflare merged commit 7af60a4 into production Jul 20, 2026
24 checks passed
@ravindra-cloudflare
ravindra-cloudflare deleted the realtimekit/update-sdk-reference branch July 20, 2026 10:45
@github-actions

Copy link
Copy Markdown
Contributor

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.

4 participants