@@ -162,6 +162,37 @@ keys per call) — a two-bar or two-line comparison redrawn in brand style from
162162
163163---
164164
165+ ## Asset 4 — Repo social preview card (og: image )
166+
167+ ** Goal.** Control the link preview when the repo is shared (Slack, Discord, X, LinkedIn, …). Without
168+ it, GitHub serves an auto-generated card — repo name plus contributor stats — that says nothing about
169+ what the Stack does.
170+
171+ ** Placement.** Not embedded in the README: uploaded via ** repo Settings → General → Social preview** .
172+ GitHub then serves it as ` og:image ` / ` twitter:image ` for links to the repo and its files (issues, PRs,
173+ and commits keep their own auto-generated cards).
174+
175+ ** Companion text.** The ` og:description ` comes from the repo's ** About description** field — GitHub
176+ doesn't allow arbitrary meta tags. Set it to the messaging brief's one-liner:
177+ * "Searchable, application-level encryption for building privacy-first apps."*
178+
179+ ** Spec.**
180+
181+ - ** 1280×640px** (2:1 ratio), PNG, under 1 MB (GitHub minimum 640×320).
182+ - Single theme — no light/dark switching exists for og: images . Use the dark brand look of
183+ cipherstash.com, which also matches how most chat clients render cards.
184+ - Content readable in one glance, three elements max: CipherStash logo + "CipherStash Stack" wordmark,
185+ the one-liner tagline, and a tiny code fragment selling the sizzle (e.g. ` email eql_v3.text_match `
186+ or ` .ilike("email", "%@acme.com") // runs on ciphertext ` ).
187+ - ** Safe margins:** keep text ≥64px from every edge — some clients crop edges and round corners.
188+ - Keep the export in-repo (` docs/images/social-preview.png ` ) so it's version-controlled, even though
189+ GitHub serves its own uploaded copy.
190+
191+ ** Shipping steps:** upload via Settings → Social preview, set the About description, then verify with
192+ a fresh paste into Slack/Discord (previews are cached — use opengraph.xyz or similar to confirm).
193+
194+ ---
195+
165196## Suggested files
166197
167198| File | Asset | Status |
@@ -174,6 +205,7 @@ keys per call) — a two-bar or two-line comparison redrawn in brand style from
174205| ` docs/images/type-safety.mp4 ` | Optional higher-quality GitHub embed | todo |
175206| ` docs/images/perf-latency-light.svg ` | Flat-latency chart — light | todo |
176207| ` docs/images/perf-latency-dark.svg ` | Flat-latency chart — dark | todo |
208+ | ` docs/images/social-preview.png ` | Repo social preview card (1280×640) | todo |
177209
178210The architecture diagram is embedded in the README via a single ` <picture> ` element that selects one
179211of the four variants from ** two** dimensions at once — theme (` prefers-color-scheme ` ) and viewport width
0 commit comments