From 1e7699d837b8f01724da56989db652b93beca7ed Mon Sep 17 00:00:00 2001 From: Darren Apfel Date: Mon, 24 Aug 2026 20:15:03 -0700 Subject: [PATCH 1/4] docs: add status sections, fix the React quick start, drop the broken CSS import - Status sections in the root README and both package READMEs state that these packages are experimental and pre-1.0 and name @deepgram/sdk (the official JavaScript SDK) as the supported production path for the Voice Agent API. The package READMEs are what npmjs.com renders, so the label now appears where installers actually look. - The React quick start imported '@deepgram/ui/styles.css', which fails to build against the published @deepgram/ui 0.1.4 (the file ships raw Tailwind source; see the fix staged in the deepgram/ui repository). The import is also unnecessary: compiled styles are embedded in the JS bundle and injected automatically. The example now omits it and says so. - The same example rendered AgentConversation with no children, which shows nothing (the component renders only its children); it now uses the useAgentConversation hook in a child component, matching the @deepgram/ui package README. - The development clone command used an SSH remote; it now uses HTTPS so it works without a GitHub SSH key. - The SDK package README now shows npm install first, with bun as the alternative, since npm is the default for most readers. Validated: the corrected React example is the same pattern built clean-room with Vite 8 against packed @deepgram/ui on 2026-08-24; the widget quick start ('npm install @deepgram/agents-widget', import { init }) was built clean-room the same day. Co-Authored-By: Claude Fable 5 --- README.md | 32 +++++++++++++++++++++++++++----- packages/sdk/README.md | 10 ++++++++++ packages/widget/README.md | 4 ++++ 3 files changed, 41 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 993eb93..2d025ed 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Voice agent SDK and embeddable widget for the [Deepgram Agent API](https://devel @deepgram/agents ← @deepgram/react (external) ← @deepgram/ui (external) ← @deepgram/agents-widget ``` +## Status + +These packages are experimental and pre-1.0. Interfaces may change between minor versions, and releases are cut as the libraries evolve rather than on a fixed schedule. For a production integration with the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent), the documented and supported path is the official JavaScript SDK, [`@deepgram/sdk`](https://github.com/deepgram/deepgram-js-sdk). The packages in this family build on that API to provide embeddable browser components and are ready to evaluate and prototype with today. + ## Packages | Package | Description | @@ -42,9 +46,25 @@ The package also ships a UMD bundle at `dist/widget.umd.js` for `