docs(stack-drizzle): conversion-focused README rewrite#775
Conversation
The package README documented mechanics without ever making the case. Rewritten along the lines of the root-README refresh in #526: a bold searchable-encryption lead, the zero-knowledge trust line up front, a ciphertext-queries example before any setup, a query-type table mapping the ops.* surface to the docs, an account-first quick start, a How-it-works section on EQL payloads and searchable terms, and reference-style links with UTM attribution (stack_drizzle_readme). The quickstart, indexing, and v2-legacy sections are retained. All API claims match the shipped surface (ops.matches/contains, not the doc-driven ilike forms from #526's root draft). No code changes. Claude-Session: https://claude.ai/code/session_01BkEpKJC3975NHsKgMrCT8R
🦋 Changeset detectedLatest commit: b668412 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe PR refreshes the Stack Drizzle README with updated encryption, querying, setup, indexing, EQL, and legacy-version guidance, and adds a patch changeset. No implementation or exported API changes are included. ChangesStack Drizzle documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
…exes, bounded trade-off Replaces the trust blockquote with the team's threat-model-first framing: who normally sees everything, per-value identity-derived keys with audited decryption, how queries still work (deterministic encryption / ORE / bloom filters over native Postgres indexes), and the explicit leakage boundary — equality and order relationships, nothing else; not FHE. Claude-Session: https://claude.ai/code/session_01BkEpKJC3975NHsKgMrCT8R
The
@cipherstash/stack-drizzleREADME documented mechanics without making the case for the package. We're about to file an upstream drizzle-orm bug report that links here, so the landing page should sell.Rewritten borrowing the structure Dan built for the root README in #526:
ops.*surface to the searchable-encryption docs anchors.npx stash init, with the manual install as the alternative.utm_source=github&utm_medium=stack_drizzle_readmeon cipherstash.com links (same pattern as docs: refresh root README around the three Stack pillars #526, distinct medium).encryptedIndexessection, the v2 legacy section, and the@cipherstash/drizzledisambiguation note.One deliberate divergence from #526's root draft: that README is doc-driven and shows
ops.ilike/cipherstashIlike; this one ships in the npm tarball today, so every API named here is the shipped surface (ops.matches/ops.contains).Changeset:
@cipherstash/stack-drizzlepatch (README ships in the tarball).https://claude.ai/code/session_01BkEpKJC3975NHsKgMrCT8R
Summary by CodeRabbit
stack-drizzleREADME to better explain application-level encryption with Drizzle ORM and PostgreSQL, including “Encrypted columns. Real Drizzle queries.”