@levino/shipyard-docs 0.8.1 → 0.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@levino/shipyard-docs",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "Documentation plugin for shipyard with automatic sidebar, pagination, and git metadata",
   "type": "module",
   "main": "src/index.ts",
@@ -27,7 +27,7 @@
     "effect": "^3.20.0",
     "ramda": "^0.31",
     "unist-util-visit": "^5.0.0",
-    "@levino/shipyard-base": "^0.8.1"
+    "@levino/shipyard-base": "^0.8.2"
   },
   "devDependencies": {
     "@tailwindcss/typography": "^0.5.16",

package/src/index.ts

@@ -87,13 +87,14 @@ const docsSchemaBase = (image: () => z.ZodType) =>
     /** SEO keywords */
     keywords: z.array(z.string()).optional(),
     /**
-     * Social preview image. Accepts either:
-     * - A relative path to a local image file (e.g. `./hero.png`), which is
-     *   automatically optimized to 1200×630 JPEG for OG/Twitter cards.
-     * - An absolute URL (e.g. `https://example.com/og.jpg`), passed through
-     *   verbatim.
+     * Social preview image. Must be a relative path to a local image file
+     * (e.g. `./hero.png`). Astro's `image()` schema helper turns the path
+     * into an `ImageMetadata` reference, which shipyard runs through Astro's
+     * image pipeline at build time to produce a 1200×630 JPEG variant for
+     * OG/Twitter cards. Drop in a phone-camera JPEG and shipyard handles the
+     * cropping, downscaling and EXIF stripping.
      */
-    image: z.union([image(), z.string().url()]).optional(),
+    image: image().optional(),
     /** Custom canonical URL */
     canonicalUrl: z.string().optional(),
     /** Custom canonical URL - snake_case alias for Docusaurus compatibility */