Skip to content

docs(realtimekit): fix web core reference to have correct typical names and only expose useful methods - #32193

Merged
renandincer merged 3 commits into
productionfrom
realtimekit/fix-web-core-reference
Jul 22, 2026
Merged

docs(realtimekit): fix web core reference to have correct typical names and only expose useful methods#32193
renandincer merged 3 commits into
productionfrom
realtimekit/fix-web-core-reference

Conversation

@ravindra-cloudflare

@ravindra-cloudflare ravindra-cloudflare commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  1. Web Core Reference for RealtimeKit team was harder to understand due to the lack of proper typicalnames.
  2. Indexing that gets shown on right was wrong.
  3. A lot of internal only methods were documented that could easily break client implementations.
  4. Files like src/content/docs/realtime/realtimekit/core/api-reference/RTKSelfMedia.md were poorly documented.
  5. Files like RTKParticipantsMap.md were not even useful for clients as they cannot access the raw map directly.
  6. Added redirect for the deleted file RTKParticipantsMap.
  7. This code is autogenerated based on changes that were done in RealtimeKit Web Core SDK Repo.

Screenshots (optional)

Before
image

After
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 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 21, 2026 06:55
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 787155c.

Code Review

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

No code review issues found.

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. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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

Pattern Owners
/public/__redirects @cloudflare/content-engineering, @cloudflare/product-owners
/src/content/docs/realtime/ @cloudflare/product-owners, @cloudflare/realtime, @cloudflare/RealtimeKit, @roerohan, @ravindra-cloudflare

@ravindra-cloudflare
ravindra-cloudflare requested a review from a team as a code owner July 21, 2026 06:58
@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

@renandincer
renandincer merged commit 6f6b296 into production Jul 22, 2026
23 checks passed
@renandincer
renandincer deleted the realtimekit/fix-web-core-reference branch July 22, 2026 03:03
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