Skip to content

docs(providers): drop the last current-tense Vercel AI SDK claims - #1715

Merged
murdore merged 1 commit into
releasefrom
docs/ai-sdk-claims-residue
Sep 17, 2026
Merged

murdore merged 1 commit into
releasefrom
docs/ai-sdk-claims-residue

Conversation

@murdore

@murdore murdore commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Review follow-up on the open thread from #1714 (docs/getting-started/providers/openai.md).

#1714 corrected seven passages that described NeuroLink as running on the Vercel AI SDK. The reviewer pointed out that openai.md still contradicted its own new Overview a few hundred lines further down, and named two more files the sweep had missed. Re-sweeping the hand-written docs turned up three more of the same shape, so all six land here.

Every line below asserted that NeuroLink currently runs on a package that is not in package.json, not in pnpm-lock.yaml, and imported nowhere under src/.

File Claimed Actually
docs/getting-started/providers/openai.md streaming "uses the Vercel AI SDK streamText with fullStream" NeuroLink's own HTTP + SSE client, src/lib/providers/openaiChatCompletionsBase.ts
docs/features/pdf-support.md flow step 6 "Format as Vercel AI SDK file type" messageBuilder emits the provider's own file/document part
docs/reference/index.md AI SDK listed as "Underlying provider implementations" a separate framework NeuroLink interoperates with, via the client SDK's LanguageModelV1 adapter
docs/getting-started/providers/google-vertex.md Gemini 3's native path "bypasses the Vercel AI SDK" because "the Vercel layer strips thoughtSignature" present tense about a layer that no longer exists; the reason is restated as the token itself
docs/features/turn-time-budget.md a section named after "the AI-SDK loop path" that is the native loop
docs/reference/provider-feature-compatibility.md Azure's rejection of the file content type attributed to the AI SDK the quoted error comes from the model API

Deliberately left alone

These reference the Vercel AI SDK as a separate thing, which is accurate, and would be wrong to remove:

  • docs/features/client-sdk.md + docs/features/index.md — the client SDK really does ship a LanguageModelV1 compatibility adapter (src/lib/client/aiSdkAdapter.ts).
  • docs/features/observability.md — about spans your application emits; the page already states NeuroLink has no dependency on ai.
  • docs/features/opencode-proxy-support.md — about OpenCode, which does use it.
  • docs/guides/index.md, docs/guides/frameworks/nextjs.md — a migration guide and an "alternative SDK" link.
  • docs/features/structured-output.md, google-ai.md, google-vertex.md:977, troubleshooting.md — "all major frameworks do this" comparisons.
  • docs/advanced/builtin-middleware.md — already says NeuroLink no longer depends on it.
  • docs/analysis/**, docs/features/claude-subscription-testing.md — historical records, already marked as such by docs(providers): describe the native provider layer instead of the removed ai-sdk #1714.

Testing

Documentation only; no source, no behaviour.

  • prettier --check on all six files: clean, no reformatting needed.
  • docs-site rebuilt; docs-site/static/search-index.json regenerated and committed, as docs-site-artifacts.yml requires. [search-index] Generated 14356 entries from 3945 files.

Summary by CodeRabbit

  • Documentation
    • Clarified PDF processing and provider-specific file handling.
    • Updated timeout terminology and provider naming.
    • Documented native Gemini 3 tool-calling support and preservation of thought signatures.
    • Clarified OpenAI streaming implementation and multi-step tool execution.
    • Refined Vercel AI SDK integration descriptions.
    • Clarified Azure OpenAI limitations with PDF file content.

Review follow-up on #1714. That PR corrected seven passages that described
NeuroLink as running on the Vercel AI SDK; the reviewer pointed out that
openai.md still contradicted its own new Overview a few hundred lines later,
and named two more files the sweep had missed. Re-sweeping the hand-written
docs surfaced three more of the same shape, so all six land together.

Every line below claimed NeuroLink CURRENTLY runs on a package that is not in
package.json, not in pnpm-lock.yaml, and imported nowhere in src/:

- openai.md: streaming said it used the AI SDK's streamText/fullStream. It is
  NeuroLink's own HTTP+SSE client in openaiChatCompletionsBase.ts.
- pdf-support.md: the processing flow formatted "as Vercel AI SDK file type".
  messageBuilder emits the provider's own file/document part.
- reference/index.md: listed the AI SDK as "underlying provider
  implementations". It is a separate framework NeuroLink interoperates with
  through the client SDK's LanguageModelV1 adapter.
- google-vertex.md: said the Gemini 3 native path "bypasses the Vercel AI SDK"
  because "the Vercel layer strips thoughtSignature" — present tense about a
  layer that no longer exists. The reason is restated as the token itself.
- turn-time-budget.md: a section named after "the AI-SDK loop path". That path
  is the native loop.
- provider-feature-compatibility.md: attributed Azure's rejection of the file
  content type to the AI SDK. The quoted error comes from the model API.

Left alone deliberately: docs that reference the AI SDK as a separate thing —
the client SDK's compatibility adapter, the observability guidance about spans
your own app emits, the OpenCode proxy page, the migration guide, and the
"all major frameworks do this" comparisons. Those are accurate.

docs-site/static/search-index.json is regenerated, as the artifacts workflow
requires.
@coderabbitai

coderabbitai Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 1ed8804d-4fa5-4a90-98f7-8f1d63791859

📥 Commits

Reviewing files that changed from the base of the PR and between e157558 and a59a872.

📒 Files selected for processing (7)
  • docs-site/static/search-index.json
  • docs/features/pdf-support.md
  • docs/features/turn-time-budget.md
  • docs/getting-started/providers/google-vertex.md
  • docs/getting-started/providers/openai.md
  • docs/reference/index.md
  • docs/reference/provider-feature-compatibility.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The pull request updates six documentation sections to describe native provider integrations, direct streaming, Gemini thought-signature preservation, PDF file parts, SDK interoperability, and Azure OpenAI API behavior.

Changes

Native provider documentation

Layer / File(s) Summary
Provider integration documentation alignment
docs/features/pdf-support.md, docs/features/turn-time-budget.md, docs/getting-started/providers/*.md, docs/reference/*.md
The documentation replaces outdated Vercel AI SDK descriptions with native provider paths, NeuroLink HTTP and SSE parsing, preserved Gemini thoughtSignature values, provider-native PDF parts, and model-level Azure OpenAI file content rejection.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to a59a8

These edits do not change runtime behavior and no concrete merge-blocking issue is established.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: removing remaining present-tense claims that NeuroLink runs on the Vercel AI SDK while preserving accurate compatibility references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Single Commit Policy - COMPLIANT

Status: Policy requirements met • 1 commit • Valid format • Ready for merge

📊 View validation details

📝 Commit Details

  • Hash: a59a872bb3425f4b77b6e4fcaf672b9758a4202e
  • Message: docs(providers): drop the last current-tense Vercel AI SDK claims
  • Author: Sachin Sharma

✅ Validation Results

  • Single commit requirement met
  • No merge commits in branch
  • Semantic commit message format verified
  • Ready for squash merge to release branch

🤖 Automated validation by NeuroLink Single Commit Enforcement

@github-actions

Copy link
Copy Markdown
Contributor

Documentation Validation Results

🚀 Documentation validation passed!

Check Status Result
Frontmatter Validation ✅ Passed
TypeScript Check ✅ Passed
Build ✅ Passed
Link Validation ✅ Passed

📦 Build artifact uploaded successfully. Ready for deployment preview.

Commit: 473724b4b78f5ab5a67bd04fdf9e4257048d408a | Workflow: View logs

@murdore
murdore merged commit 84794d2 into release Sep 17, 2026
30 checks passed
@murdore
murdore deleted the docs/ai-sdk-claims-residue branch September 17, 2026 23:13
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 12.14.17 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Tara-ag

Tara-ag commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

APPROVE — accurate, scoped, well-followed docs cleanup

All six edited passages were verified against source and are accurate; the regenerated search-index.json is current (the "Generated artifacts are current" check and the docs validation check both pass), commit message follows the docs(scope) convention, and the heading rename in turn-time-budget.md breaks zero links (no ai-sdk-loop-path anchor referenced anywhere). Zero runtime blast radius (0 changed functions/flows, risk 0.00) — documentation only.

# Severity Location Finding
1 MINOR (follow-up) docs/image-generation-streaming.md:91 Same stale present-tense claim this PR exists to remove — "Uses Vercel AI SDK's native streamText() function" — in a hand-written doc the sweep missed
2 MINOR (follow-up, kept) src/lib/types/generate.ts + docs/api/type-aliases/GenerateOptions.md JSDoc/TypeDoc still say "the AI-SDK loop path (direct Anthropic, litellm, OpenAI-compatible)" — confirmed real, reaches live readers via the shipped TypeDoc page; out of scope for a docs-only PR

Thread resolutions from the prior round:

  • yama:reference-index-adapter-wording (thread feat: Complete Visual Ecosystem + Automated NPM Publishing v1.1.0 #2) — resolved. My own earlier finding claimed the client SDK does not ship the LanguageModelV1 adapter. That premise is wrong: src/lib/client/index.ts explicitly exports createNeuroLinkProvider, NeuroLinkLanguageModel, NeuroLinkProvider as NeuroLinkAIProvider. The new wording "Separate framework NeuroLink interoperates with via the client SDK's LanguageModelV1 adapter" is accurate. Resolved as a false positive.
  • yama:ai-sdk-loop-path-source-residue (thread Rebrand to neurolink #1) — kept. Confirmed against source and now additionally confirmed to ship on the docs site via docs/api/type-aliases/GenerateOptions.md. No author reply; head commit unchanged.

Verified accurate (no findings):

  • openai.md:334 → openaiChatCompletionsBase.ts is a direct HTTP+SSE client ("A direct HTTP client + multi-step tool-execution loop driven by SSE", "Nothing here imports from ai or @ai-sdk/*"); handles text and tool-call chunks (streamOneStep/executeToolBatch); runStreamLoop drives maxSteps. Also the shared base of OpenAI, Azure, DeepSeek, LiteLLM, and the OpenAI-compatible family — citation is correct.
  • pdf-support.md:852 → messageBuilder.ts emits a type: "file" part; provider clients map PDF → provider-native part (OpenAI file / Anthropic document / Gemini inlineData), then "Send to provider's native PDF API" — accurate.
  • google-vertex.md:349 → native @google/genai path confirmed (googleNativeGemini3/utils.ts extractThoughtSignature); the historical "Vercel stripped thoughtSignature" claim is corroborated in memory-bank/techContext.md and the removal plans. The :977 mention is an "all frameworks do this" comparison, correctly left alone.
  • provider-feature-compatibility.md:223 → the quoted Azure error ('file' does not support file content types) appears nowhere in src/, so "comes from the model API itself" is accurate.
  • reference/index.md:238 → swap from the flatly-wrong "Underlying provider implementations" to the interop wording (see thread feat: Complete Visual Ecosystem + Automated NPM Publishing v1.1.0 #2).
  • CI: single-commit policy, docs validation, search-index currency, CodeQL, secret scan, all green.

One suggested follow-up for a later docs pass: docs/image-generation-streaming.md:89-91 still claims NeuroLink's text streaming "Uses Vercel AI SDK's native streamText() function" — fold it into this cleanup (replace with the native HTTP+SSE wording used elsewhere). Lower priority: docs/implementation-guides/14-rag-document-processing.md and docs/provider-integration/* phrases describing a Tool/Zod-shape compatibility are accurate (type shape, not dependency) and can stay.

@Tara-ag Tara-ag left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving — accurate, scoped docs cleanup; all six claims verified against source and the regenerated search-index is current. Follow-ups noted in the summary comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants