Skip to content

Conversation

@thomasyuill-livekit
Copy link
Contributor

@thomasyuill-livekit thomasyuill-livekit commented Jan 12, 2026

Summary

  • Add documentation generation for shadcn components - New doc-gen.ts script uses react-docgen-typescript to extract and output prop types to prop-types.json
  • Improve JSDoc comments across agents-ui components - Added detailed prop descriptions and examples to AgentSessionProvider, AgentChatTranscript, AgentChatIndicator, AgentDisconnectButton, StartAudioButton, visualizers, and track controls
  • Enhance Storybook controls - Updated argTypes for better interactivity in stories (flattened nested controls, added missing prop controls, fixed control types)
  • Fix component prop forwarding - Added ...props spread and ComponentProps<'element'> types to properly forward HTML attributes
  • Normalize registry naming - Updated component titles for consistency (e.g., "Audio Bar Visualizer" → "Agent Audio Visualizer Bar")
  • Add shadcn README

Related to https://github.com/livekit/web/pull/2798

  • new

Testing

  • Copy .env.example and update DEST vars
  • Run pnpm registry:build to verify doc generation works
  • Verify dist/prop-types.json contains expected component documentation
  • Run Storybook and confirm controls work correctly for updated stories

@changeset-bot
Copy link

changeset-bot bot commented Jan 12, 2026

⚠️ No Changeset found

Latest commit: b05eec2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 12, 2026

size-limit report 📦

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

@lukasIO
Copy link
Contributor

lukasIO commented Jan 12, 2026

how and where are we planning to consume the prop-types.json ?
Asking because we already have an automated doc generation workflow as part of this repo based on api-extractor

@thomasyuill-livekit
Copy link
Contributor Author

how and where are we planning to consume the prop-types.json ?

https://github.com/livekit/web/pull/2798

We use it in

Copy link
Contributor

@1egoman 1egoman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally makes sense to me. I'm assuming you are holding off on all the argTypes todos for a future pull request?

@thomasyuill-livekit
Copy link
Contributor Author

I'm assuming you are holding off on all the argTypes todos for a future pull request?

Ahh good catch, I'll clean that up

I had an agent review the stories and make note of the props we weren't being exposed.
I then decided against exposing all of them because some of them don't provide value

For instance

  • tailwind wont pick up classnames passed in that havent already been used
  • you can't provide a custom callback

@thomasyuill-livekit thomasyuill-livekit merged commit 5649ce1 into main Jan 12, 2026
6 checks passed
@thomasyuill-livekit thomasyuill-livekit deleted the ty/shadcn-tweaks branch January 12, 2026 21:25
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.

4 participants