docs: add status sections and switch development clones to HTTPS - #21
Open
darrenapfel wants to merge 2 commits into
Open
docs: add status sections and switch development clones to HTTPS#21darrenapfel wants to merge 2 commits into
darrenapfel wants to merge 2 commits into
Conversation
- Status sections in the root README and the package README (the file
npmjs.com renders) state that the package is experimental and pre-1.0 and
name @deepgram/sdk (the official JavaScript SDK) as the supported
production path for the Voice Agent API.
- The development clone commands used SSH remotes, which fail for anyone
without a GitHub SSH key; they now use HTTPS.
The advertised install path ('npm install @deepgram/react @deepgram/agents')
and the quick-start example were verified working in a clean-room Vite 8
build on 2026-08-24; no changes were needed there.
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>
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 changes. Status sections in the root README and the package README (the file npmjs.com renders) state that the package is 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 commands used SSH remotes, which fail for anyone without a GitHub SSH key; they now use HTTPS.Validation. The advertised install path (
npm install @deepgram/react @deepgram/agents) and the quick-start example were verified working in a clean-room Vite 8 build on 2026-08-24, so no code-facing changes were needed. 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