fix: add docs for building custom plugins#31388
Open
ishita1805 wants to merge 1 commit into
Open
Conversation
ishita1805
requested review from
a team,
ravindra-cloudflare and
roerohan
as code owners
Contributor
Review❌ Review failed for commit |
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Summary
This PR adds documentation for building custom plugins in RealtimeKit, including:
- A new
plugins.mdxreference guide under/realtime/realtimekit/core/plugins/ - A new
custom-plugins/section with an overview page and abuild-your-own-plugins.mdxhow-to guide - Updates to the
rtk-plugin-mainAPI reference pages for React, Angular, and Web Components to describe slot projection behavior - Updates the
meeting.pluginscode examples inmeeting-object-explained.mdxto use the per-pluginactivate()/deactivate()API
Issues to address
1. Duplicate sidebar orders ⚠️
Two new pages use sidebar.order values that conflict with existing pages in the same sidebar group:
src/content/docs/realtime/realtimekit/core/plugins.mdxhasorder: 14, which conflicts withvideo-effects.mdx(alsoorder: 14) in the same directory.src/content/docs/realtime/realtimekit/custom-plugins/index.mdxhasorder: 11, which conflicts withfaq.mdx(alsoorder: 11) in the parent directory.
Please pick unique order values to avoid non-deterministic sidebar ordering.
2. Missing description frontmatter
The following new pages are missing the recommended description field (used for SEO meta descriptions):
src/content/docs/realtime/realtimekit/core/plugins.mdxsrc/content/docs/realtime/realtimekit/custom-plugins/build-your-own-plugins.mdxsrc/content/docs/realtime/realtimekit/custom-plugins/index.mdx
3. Missing period in note block
In src/content/docs/realtime/realtimekit/custom-plugins/build-your-own-plugins.mdx (line ~153), the note is missing a trailing period:
:::note
If you use the UI Kit, the plugin components handle activation and rendering for you
:::Should be:
:::note
If you use the UI Kit, the plugin components handle activation and rendering for you.
:::Observations
- Internal links look correct (including the slug-override link to
/realtime/realtimekit/broadcast-apis/). - Code block languages are properly lowercase (
ts,tsx,js,jsx). - No unescaped
{,},<, or>characters detected in prose outside code blocks. - The API reference updates are consistent across React, Angular, and Web Components.
- The documentation checklist in the PR body asks about a changelog entry. Consider adding one if this documents a newly shipped feature.
Contributor
|
I have completed the review of PR #31388 and posted it as a Changes requested review on the pull request. Labels applied
Summary of changes in the PRThe PR adds documentation for building custom plugins in RealtimeKit, including:
Issues flagged
I also verified that internal links, code block languages, and MDX escaping all look correct. |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the APIs around the plugins feature in RealtimeKit and adds guides for creating custom plugins.
Screenshots (optional)
Documentation checklist