Skip to content

QVAC-23467 doc: point Bare consumers at @qvac/inference - #4018

Open
opaninakuffo wants to merge 4 commits into
mainfrom
doc/QVAC-23467-deprecate-bare-sdk
Open

QVAC-23467 doc: point Bare consumers at @qvac/inference#4018
opaninakuffo wants to merge 4 commits into
mainfrom
doc/QVAC-23467-deprecate-bare-sdk

Conversation

@opaninakuffo

@opaninakuffo opaninakuffo commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

🎯 What problem does this PR solve?

  • @qvac/bare-sdk is discontinued after 0.18.1. Docs, READMEs, and the Bare plugin-registration error still send in-process Bare users to that package.
  • There will not be a 0.19.0 of @qvac/bare-sdk. Those users should assemble plugins on @qvac/inference.

📝 How does it solve it?

  • Rewrite the @qvac/bare-sdk README as a deprecation + migrate-to-inference page.
  • Point architecture docs, repository layout, website SDK/plugin pages, and the @qvac/sdk / @qvac/inference READMEs at inference.
  • Update WORKER_PLUGINS_NOT_REGISTERED copy to recommend @qvac/inference.

Pipeline / package deletion is a follow-up: #4019.

🧪 How was it tested?

  • Copy review of the deprecation wording (last release 0.18.1; no 0.19 of this package).
  • No runtime tests. Historical changelogs and release-notes MDX left unchanged.

@opaninakuffo
opaninakuffo requested review from a team as code owners August 24, 2026 11:46
@github-actions

Copy link
Copy Markdown
Contributor

Review Status

Current Status: ❌ PENDING
Approvals so far: none

Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member.

@github-actions

Copy link
Copy Markdown
Contributor

License compliance — clean

No new dependency license findings in this PR.

Warn-only (shadow) mode — this check does not block merges yet.

Updated automatically by the canonical license compliance workflow.

NOTICE presence (advisory)

Missing NOTICE (advisory, does not block):

  • ./.github/actions/release-merge-guard
  • ./docs/website
  • ./packages/ggml-coload-smoke
  • ./packages/fabric/test/integration
  • ./packages/inference-addon-cpp/mobile
  • ./packages/sdk/e2e
  • ./packages/llm-llamacpp/benchmarks/performance
  • ./packages/llm-llamacpp/benchmarks/server
  • ./packages/vla-ggml/sim/server
  • ./packages/embed-llamacpp/benchmarks/performance
  • ./packages/embed-llamacpp/benchmarks/server
  • ./packages/asr-ggml/benchmarks/server

@arun-mani-j arun-mani-j 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.

Thanks. I think we should reshuffle the docs a bit to clarify three things:

  • SDK no longer runs on Bare (it never did as it is actually, users needed to register plugins etc.).
  • People who want to run QVAC on Bare should use inference.
  • Bare SDK is deprecated.

We should do it as current fact as it is, instead of narrating it as journey ("SDK once supported Bare, but no longer, use Inference...").

Comment thread docs/architecture/ARCHITECTURE.md Outdated
Comment thread docs/architecture/ARCHITECTURE.md Outdated
Comment thread docs/website/content/docs/configuration/plugins/index.mdx Outdated
@qvac/bare-sdk is discontinued after 0.18.1; docs and error copy should send in-process Bare users to the engine instead of the deprecated package.
packages/sdk/examples/quickstart.bare.ts is gone; the docs site build failed on the leftover file= import.
Drop the leftover SDK-on-Bare compatibility copy from the deprecation docs.
@opaninakuffo
opaninakuffo force-pushed the doc/QVAC-23467-deprecate-bare-sdk branch from 64c9ad6 to 7ae47be Compare August 25, 2026 10:57
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.

2 participants