Skip to content

docs: scope to RAG and agentic LLM apps (not voice/audio)#12

Merged
OmkarRayAI merged 1 commit into
mainfrom
docs/scope-rag-and-agentic-clean
Jun 5, 2026
Merged

docs: scope to RAG and agentic LLM apps (not voice/audio)#12
OmkarRayAI merged 1 commit into
mainfrom
docs/scope-rag-and-agentic-clean

Conversation

@OmkarRayAI

Copy link
Copy Markdown
Owner

Summary

Tightens user-facing copy across the README, ROADMAP, examples, sdk-js, pyproject, and package.json so a voice-AI developer reading any landing surface self-selects out cleanly. The product never targeted voice/audio/realtime — the span model is text-completion shaped (prompt_chars, output_tokens, token deltas), token-streaming only. Generic "LLM observability" framing was reading as universal.

This PR is the result of a parallel scope-audit workflow that scanned all 7 user-facing surfaces and produced 12 verbatim-quote-backed edit recommendations. The 12 most-load-bearing are applied here.

Diff (no code, no test changes)

File Change
README.md Hero tagline → "RAG and agentic LLM applications"; codename callout drops "general-purpose"; "every LLM call" → "every text LLM call in your RAG or agent pipeline"; Integrations intro grounded
examples/README.md "cost + streaming" → "cost + token streaming"; "arbitrary Python" → "RAG and agent steps in Python"
sdk-js/README.md + sdk-js/package.json Tagline grounds scope to RAG/agentic; keywords gain agents, agentic
ROADMAP.md "streaming traces" → "live text traces"; Won't-do list adds explicit voice/audio/multimodal-realtime line with rationale
pyproject.toml PyPI description prefixes "RAG and agentic"; keywords gain agents, agentic

Why this matters

A reader's first scope signal is the page-1 tagline. Before this PR, every landing surface said some variant of "observability for LLM apps" — that scoped in voice/audio devs who'd then bounce when they discovered no audio-stream support. After: each surface anchors in RAG + agent workflows, which is what the product actually does. No defensive "voice not supported" disclaimer — just precise nouns where vague nouns were.

Test plan

  • CI green on this PR (no code changes, no behavior changes)
  • Verify PyPI description preview matches expectation
  • Verify npm description preview matches expectation

🤖 Generated with Claude Code

Tightens user-facing copy across README, ROADMAP, examples, sdk-js,
pyproject, and package.json so a voice-AI developer reading any
landing surface self-selects out cleanly. The product never targeted
voice/audio/realtime: span model is text-completion shaped
(prompt_chars, output_tokens, token deltas), token-streaming only.
Generic "LLM observability" framing was reading as universal.

Edits, all surgical:

README.md
- Hero tagline: "for LLM applications" -> "for RAG and agentic LLM applications"
- Codename callout: dropped "general-purpose"
- "every LLM call" -> "every text LLM call in your RAG or agent pipeline"
- Integrations intro: tightened to text LLM APIs in RAG/agent workflows

examples/README.md
- "cost + streaming" -> "cost + token streaming"
- "arbitrary Python" -> "RAG and agent steps in Python"

sdk-js/README.md + sdk-js/package.json
- Tagline grounds scope to RAG/agentic
- Keywords gain agents and agentic

ROADMAP.md
- "Browser dashboard for streaming traces" -> "live text traces"
- Wont-do list adds explicit voice/audio/multimodal-realtime line
  with rationale (text-completion-shaped span model)

pyproject.toml
- PyPI description prefixes "RAG and agentic" before LLM apps
- Keywords gain agents and agentic

Net effect: a developer landing on the repo, npm, or PyPI sees the
actual scope by line 1. No defensive disclaimer, no rewrite, just
precise nouns where vague nouns were.

Verified: pytest -q tests/ -> 88 passed, 14 skipped.
@OmkarRayAI OmkarRayAI merged commit 1e68ee0 into main Jun 5, 2026
4 checks passed
@OmkarRayAI OmkarRayAI deleted the docs/scope-rag-and-agentic-clean branch June 5, 2026 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant