docs(agents): add LLM-usage instructions inside ui-kit - #84
Closed
bryceosterhaus wants to merge 1 commit into
Closed
bryceosterhaus wants to merge 1 commit into
bryceosterhaus wants to merge 1 commit into
Conversation
Add AGENTS.md with instructions for AI coding agents working in or with the ElevenLabs UI registry: component inventory (audio/agentic + shadcn primitives + blocks + hooks), install commands, import conventions, Tailwind v4 / oklch design system and theming, ElevenLabs SDK usage (@elevenlabs/react, @elevenlabs/elevenlabs-js), recommended patterns for voice chat / streaming responses / message lists, and contributing workflow. Link to it from the README so agents and contributors discover it. Resolves IDX-281. Co-authored-by: Bryce Osterhaus <bryceosterhaus@gmail.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
bryceosterhaus
marked this pull request as ready for review
September 10, 2026 06:23
Member
Author
|
not meant for this repo |
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
2 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
Resolves IDX-281 — Add LLM-usage instructions inside ui-kit (project: Make agents use our frontend components).
Adds an
AGENTS.mdat the repo root with instructions for AI coding agents (Cursor, Claude Code, etc.) so they generate frontend code that uses our components and matches the design — the KR 2.5 goal.What's in
AGENTS.md@elevenlabs/cli+shadcnCLI variants, prerequisites.@elevenlabs/reactvs@elevenlabs/elevenlabs-jsvs@elevenlabs/client.@/components/ui/*,"use client",cn, and the reminder to check the user'scomponents.jsonaliases..dark), themes (.theme-*), radius scale, animations, lucide icons.voice-chat-01), streaming responses (<Response>/streamdown), message lists, orb audio reactivity.pnpm build:registry, commit conventions.ConversationProviderrequirement, Three.js weight, hardcoded colors, etc.).Other changes
README.mdlinking toAGENTS.mdfor discoverability.Verification
apps/www/registry.jsonand the source inapps/www/registry/elevenlabs-ui/.pnpm dev,pnpm build:registry), and design-system details (Tailwind v4, oklch tokens, themes) againstapps/www/styles/globals.css,apps/www/components.json, and the existing docs.Notes
The instructions are deliberately framework-agnostic enough to help any agent consuming the kit, while also covering contribution workflow for agents working inside this repo.
Linear Issue: IDX-281