Skip to content

Add examples for all useDataChannel usages to the first definition #1136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 14, 2025

Conversation

bcherry
Copy link
Contributor

@bcherry bcherry commented May 12, 2025

we currently have two entries in the table of contents that look identical. due to the design of our docs gen, there's no good solution without tradeoffs.

I think the most sensible thing to do is just document only one of them, with an example of usage without a topic. alternatively we could just get rid of the overrides and keep the one method that does both and has more complex type signatures and document that, but i think this approach here is best.

Update: @lukasIO fixed the doc gen to just drop extra overloads so this PR is now just about adding all examples to the first one. #1138

@bcherry bcherry requested a review from lukasIO May 12, 2025 17:44
Copy link

changeset-bot bot commented May 12, 2025

🦋 Changeset detected

Latest commit: 85a4480

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@livekit/components-js-docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented May 12, 2025

size-limit report 📦

Path Size
LiveKitRoom only 5.98 KB (0%)
LiveKitRoom with VideoConference 30.38 KB (0%)
All exports 37.64 KB (0%)

@bcherry bcherry requested a review from lukasIO May 13, 2025 21:25
@bcherry bcherry changed the title Only document one of the useDataChannel overrides Add examples for all useDataChannel usages to the first definition May 13, 2025
@lukasIO lukasIO merged commit da30fb1 into main May 14, 2025
6 checks passed
@lukasIO lukasIO deleted the bcherry/dupe-udc branch May 14, 2025 12:28
@github-actions github-actions bot mentioned this pull request May 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants