Skip to content

docs: fix the claims that contradict the code - #39

Merged
PunGrumpy merged 8 commits into
mainfrom
docs/fix-contradictions
Sep 25, 2026
Merged

PunGrumpy merged 8 commits into
mainfrom
docs/fix-contradictions

Conversation

@PunGrumpy

@PunGrumpy PunGrumpy commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

Background

An audit of the docs against the code found claims that the code does not back up.

  • The filters page said "the compilers are total", but the Vectorize and Redis compilers return a Result and can refuse a filter.
  • The migration guide said to export records with fetch, which needs ids the SDK cannot list.
  • The Vectorize and Pinecone pages said to clear records by querying once and deleting the matches. That misses everything past topK.
  • Provider pages still said "do not write metadata under that name". Since 0.1.2, upsert rejects that metadata.
  • The store and migration pages promised that a record that upserts on one provider upserts on all of them.
  • The landing page listed Upstash among the providers with native namespaces. Its default mode emulates them.
  • Two counts were wrong. RedisClientLike has seven calls, not eight, and "the other three adapters" on the Upstash page should be six.
  • docs/releasing.md did not list the VERCEL_DEPLOY_HOOK secret the release job needs.

Stacked on #38. No code changes, so there is no changeset.

The landing highlights, captured on production and on this PR's Vercel preview at 1440px wide:

Before (Landing highlights) After (Landing highlights)
Before After

Summary

  • The filters page says five compilers accept every filter, and names what the Vectorize and Redis compilers refuse.
  • The Vectorize page notes that a Worker needs nodejs_compat, because the adapter imports node:crypto. The query-then-delete recipe now loops until a query returns nothing.
  • The Qdrant, Upstash, Vectorize, and Redis pages list the rules upsert and the verbs enforce, and the batch sizes they use.
  • The Pinecone delete recipe loops until a query returns nothing.
  • The store and migration pages list each adapter's extra rules instead of the "upserts on all of them" promise.
  • The migration page explains how to export ids with each provider's own call through store.raw.
  • The testing and migration pages name the builders the live suite runs.
  • The design page corrects the call count. The releasing guide lists the deploy hook secret and the snapshot caveat.
  • The landing highlight says Pinecone and Vectorize have native namespaces, and that Upstash is emulated.

Verification

  • bun run check exits 0.
  • cd apps/web && bun run typecheck exits 0.
  • bun run test in packages/vecstore-sdk shows 398 pass, 0 fail.
  • Each corrected number was checked against the source. Qdrant sends 500 points per upsert and 1,000 ids per fetch or delete. Redis writes 500 records per batch. RedisClientLike has seven calls. listVectors exists in cloudflare 7.1.

Checklist

  • Tests have been added or updated. Not applicable, because this PR only changes docs.
  • Documentation has been added or updated
  • A changeset has been added for vecstore-sdk (run bun run changeset in the project root). Not needed, because nothing under packages/*/src or a manifest changes.
  • I have reviewed this pull request myself

@PunGrumpy PunGrumpy added the documentation Improvements or additions to documentation label Sep 25, 2026
@vercel

vercel Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
vecstore-sdk Ready Ready Preview Sep 25, 2026 7:29pm UTC

@changeset-bot

changeset-bot Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 9ab80cd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 12 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 37685839-2c5b-41d1-8dc2-f16221c2dfb9

📥 Commits

Reviewing files that changed from the base of the PR and between 0a33d23 and 9ab80cd.

📒 Files selected for processing (13)
  • apps/web/content/docs/core/filters.mdx
  • apps/web/content/docs/core/store.mdx
  • apps/web/content/docs/guides/design.mdx
  • apps/web/content/docs/guides/migration.mdx
  • apps/web/content/docs/guides/testing.mdx
  • apps/web/content/docs/providers/pinecone.mdx
  • apps/web/content/docs/providers/qdrant.mdx
  • apps/web/content/docs/providers/redis.mdx
  • apps/web/content/docs/providers/upstash.mdx
  • apps/web/content/docs/providers/vectorize.mdx
  • apps/web/lib/landing-content.ts
  • docs/releasing.md
  • packages/vecstore-sdk/README.md

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.

@baymiai

baymiai Bot commented Sep 25, 2026

Copy link
Copy Markdown

Security review: nothing to raise.

Read the documentation and landing content changes.

@pkg-pr-new

pkg-pr-new Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/vecstore-sdk@39

commit: 9ab80cd

@PunGrumpy
PunGrumpy added this pull request to stack #40 September 25, 2026 19:40
Base automatically changed from fix/supabase-install-hardening to main September 25, 2026 20:05
@PunGrumpy
PunGrumpy force-pushed the docs/fix-contradictions branch from 8c45e62 to 9ab80cd Compare September 25, 2026 20:09
@vercel

vercel Bot commented Sep 25, 2026

Copy link
Copy Markdown

Deployment failed for project vecstore-sdk with the following error:

Resource is limited - try again in 24 hours (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/pungrumpy?upgradeToPro=build-rate-limit

@PunGrumpy
PunGrumpy merged commit 0063c53 into main Sep 25, 2026
11 of 12 checks passed
@PunGrumpy
PunGrumpy deleted the docs/fix-contradictions branch September 26, 2026 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant