Remove misleading docs example

[1egoman]

Context can be found here: #1277

Closes #1277

Summary by CodeRabbit

• Documentation
  • Updated parameter naming in API documentation for improved clarity and consistency.
  • Removed outdated example usage from documentation.

[changeset-bot]

🦋 Changeset detected

Latest commit: 19b40f6

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

This PR includes changesets to release 6 packages

Name	Type
@livekit/components-react	Patch
@agents-ui	Patch
@livekit/component-example-next	Patch
@livekit/components-js-docs	Patch
@livekit/component-docs-storybook	Patch
@livekit/components-docs-gen	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

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update to useIsMuted hook with parameter name refactoring. JSDoc updated to reference trackRef instead of sourceOrTrackRef, and example usage removed. Public method signature parameter renamed for consistency; no functional changes to runtime behavior.

Changes

Cohort / File(s)	Summary
useIsMuted Hook Documentation packages/react/src/hooks/useIsMuted.ts	Updated JSDoc to rename parameter from sourceOrTrackRef to trackRef; removed example showing track source with participant; kept implementation functionally equivalent with consistent parameter naming.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A rabbit hops through docs so bright,
Renaming parameters left and right,
From sourceOrTrackRef to trackRef clear,
The API's name now shines, my dear!
Consistency blooms in every line,
A tidy change, oh how it's fine! 🌿

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately captures the main change: removing a misleading documentation example from the useIsMuted hook JSDoc.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch remove-misleading-docs-example

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

size-limit report 📦

Path	Size
LiveKitRoom only	6 KB (0%)
LiveKitRoom with VideoConference	32.46 KB (0%)
All exports	43.37 KB (0%)