wip

electric-sql · Aug 3, 2024 · 1663b07 · 1663b07
1 parent 5522305
commit 1663b07
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -47,7 +47,7 @@ export default defineConfig({
           { text: 'Quickstart', link: '/guides/quickstart' },
           // { text: 'Usage', link: '/guides/usage' },
           { text: 'Shapes', link: '/guides/shapes' },
-          // { text: 'Deployment', link: '/guides/deployment' },
+          { text: 'Deployment', link: '/guides/deployment' },
           { text: 'Writing clients', link: '/guides/write-your-own-client' }
         ]
       },

diff --git a/docs/api/clients/typescript.md b/docs/api/clients/typescript.md
@@ -29,7 +29,7 @@ The client exports a `ShapeStream` class for getting updates to shapes on a row-
 ### `ShapeStream`
 
 ```tsx
-import { ShapeStream } from '@electric-sql/next'
+import { ShapeStream } from '@electric-sql/next',
 
 // Passes subscribers rows as they're inserted, updated, or deleted
 const stream = new ShapeStream({

diff --git a/docs/guides/deployment.md b/docs/guides/deployment.md
@@ -4,4 +4,29 @@ outline: deep
 
 # Deployment
 
-This page is under construction.
+## Components
+
+...
+
+## PostgreSQL with logical replication
+
+...
+
+## Docker image
+
+...
+
+## Configuration
+
+- DATABASE_URL
+- SSL
+- IPv6
+- CACHE
+
+## Caching proxy
+
+...
+
+## Authentication
+
+...