docs: fix the install instructions and stale endpoint, add a status section - #66
Open
darrenapfel wants to merge 2 commits into
Open
docs: fix the install instructions and stale endpoint, add a status section#66darrenapfel wants to merge 2 commits into
darrenapfel wants to merge 2 commits into
Conversation
…ection
The README's only documented install path was a GitHub branch reference
('deepgram/browser-agent#main'). That install cannot work: dist/ is
gitignored and there is no prepare script, so npm delivers only LICENSE,
README.md, and package.json, and the entry point dist/index.mjs does not
exist (verified in a clean-room install on 2026-08-24). Meanwhile the
package has been on the npm registry since 2025 (currently 0.2.1) and
installs and bundles correctly from there.
Changes:
- Installation now instructs 'npm install @deepgram/browser-agent' and
explains why the GitHub reference fails.
- The 'url' attribute doc pointed at https://api.deepgram.com/v1/agent,
contradicting the working example at the top of the same README; it now
matches the current endpoint, wss://agent.deepgram.com/v1/agent/converse.
- A Status section states the experimental, pre-1.0 nature of the
components, names @deepgram/sdk as the supported production path, and
points to @deepgram/agents-widget as the more recent embeddable layer.
Validated: clean-room npm-registry install bundles under Vite 8; clean-room
GitHub-reference install reproduces the failure this README no longer
recommends.
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 fixes. The README's only documented install method is a GitHub branch reference (
"@deepgram/browser-agent": "deepgram/browser-agent#main"). That install cannot work:dist/is in .gitignore and there is no prepare script, so npm delivers a package containing only LICENSE, README.md, and package.json, and the entry pointdist/index.mjsdoes not exist. We reproduced this in a clean-room install on 2026-08-24. The package has been on the npm registry since 2025 (currently 0.2.1) and installs and bundles correctly from there — the registry saw 539 downloads of it in the week ending 2026-08-23, so real users are already on the working path the README does not mention.The change. The Installation section now instructs
npm install @deepgram/browser-agentand explains why the GitHub reference fails. Theurlattribute documentation pointed athttps://api.deepgram.com/v1/agent, contradicting the working example at the top of the same README; it now matches the current endpoint,wss://agent.deepgram.com/v1/agent/converse. A Status section states that the components are experimental and pre-1.0, names the official JavaScript SDK (@deepgram/sdk) as the supported production path for the Voice Agent API, and points readers who want an embeddable widget at@deepgram/agents-widget.Validation. Both install paths were exercised in clean-room projects on 2026-08-24: the registry install bundles under Vite 8; the GitHub-reference install reproduces the failure the README no longer recommends. The change touches only the README.
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