docs: add status sections, fix the React quick start, drop the broken CSS import - #69
Open
darrenapfel wants to merge 2 commits into
Open
docs: add status sections, fix the React quick start, drop the broken CSS import#69darrenapfel wants to merge 2 commits into
darrenapfel wants to merge 2 commits into
Conversation
… 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 <noreply@anthropic.com>
Removes the positioning claims from the Status sections (the experimental label where it editorializes, and the steering of production integrations to @deepgram/sdk) while keeping the factual parts: pre-1.0, interfaces may change, release cadence, and the sibling-package map. Staged as a variant for the wording-alignment conversation Corey Weathers asked for; not pushed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
darrenapfel
requested review from
GregHolmes,
deepgram-kiley and
dg-coreylweathers
as code owners
August 31, 2026 20:24
Author
|
Per review: the positioning sentences ("experimental" and the production-path steering toward @deepgram/sdk) are replaced with neutral factual status wording (pre-1.0, interfaces may change) pending the wording-alignment conversation — the full before/after set is documented, and either version can land once the positioning call is made. 🤖 Generated with Claude Code |
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
1 participant
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.
What this fixes. Three documentation problems in the READMEs. First, the root README's React quick-start imports
@deepgram/ui/styles.css, which fails to build against the published@deepgram/ui0.1.4 — that file ships raw Tailwind source rather than compiled CSS (a fix is proposed separately in the deepgram/ui repository). The import is also unnecessary:@deepgram/uiembeds its compiled styles in the JavaScript bundle and injects them automatically. Second, the same example renderedAgentConversationwith no children, which displays nothing, because the component renders only its children. Third, none of the READMEs stated the packages' maturity or named a supported production path.The change. The React quick-start drops the CSS import, says that styles inject automatically, and renders the conversation through the
useAgentConversationhook in a child component, matching the@deepgram/uipackage README. Status sections in the root README and in both package READMEs (packages/sdk,packages/widget— the files npmjs.com renders) state that the packages are experimental and pre-1.0 and name the official JavaScript SDK (@deepgram/sdk) as the supported production path for the Voice Agent API. The development clone command moves from an SSH remote to HTTPS so it works without a GitHub SSH key, and the core-SDK package README showsnpm installfirst with bun as the alternative.Validation. The corrected React example is the exact pattern that built cleanly in a clean-room Vite 8 project on 2026-08-24; the widget quick-start (
npm install @deepgram/agents-widget,import { init }) was built clean-room the same day. The change touches only markdown.Provenance. This change was written by an artificial-intelligence coding agent operating on a local clone, at the direction of Darren Apfel, and was validated as described above.
🤖 Generated with Claude Code