diff --git a/docs/guides/frameworks/introduction.mdx b/docs/guides/frameworks/introduction.mdx index 4f30521dbd..eb74771e78 100644 --- a/docs/guides/frameworks/introduction.mdx +++ b/docs/guides/frameworks/introduction.mdx @@ -10,14 +10,11 @@ import CardNodejs from "/snippets/card-nodejs.mdx"; import CardNextjs from "/snippets/card-nextjs.mdx"; import CardRemix from "/snippets/card-remix.mdx"; import CardSupabase from "/snippets/card-supabase.mdx"; -import CardSequin from "/snippets/card-sequin.mdx"; - - diff --git a/docs/guides/frameworks/sequin.mdx b/docs/guides/frameworks/sequin.mdx index fb8efe0d40..40abec0483 100644 --- a/docs/guides/frameworks/sequin.mdx +++ b/docs/guides/frameworks/sequin.mdx @@ -9,9 +9,7 @@ icon: "database" Often, task runs coincide with database changes. For instance, you might want to use a Trigger.dev task to generate an embedding for each post in your database: - - Sequin and Trigger.dev Overview - +Sequin and Trigger.dev Overview In this guide, you'll learn how to use Sequin to trigger Trigger.dev tasks from database changes. @@ -119,7 +117,7 @@ Start by creating a new Trigger.dev task that takes in a Sequin change event as ``` - This task takes in a Sequin record event, creates an embedding, and then uppserts the embedding into a `post_embeddings` table. + This task takes in a Sequin record event, creates an embedding, and then upserts the embedding into a `post_embeddings` table. Register the `create-embedding-for-post` task to your Trigger.dev cloud project by running the following command: @@ -184,7 +182,7 @@ This guide covers how to setup an API endpoint using the Next.js App Router. You DATABASE_URL=postgresql:// ``` - The `SEQUIN_WEBHOOK_SECRET` ensures that only Sequin can access your APIendpoint. + The `SEQUIN_WEBHOOK_SECRET` ensures that only Sequin can access your API endpoint. The `TRIGGER_SECRET_KEY` is used to authenticate requests to Trigger.dev and can be found in the **API keys** tab of the Trigger.dev dashboard. @@ -205,7 +203,7 @@ You'll now configure Sequin to send every row in your `posts` table to your Trig 1. Login to your Sequin account and click the **Add New Database** button. 2. Enter the connection details for your Postgres database. - If you need to connect to a local dev database, flip the **use localhost** switch and follow the instructions to create a tunnel using the [Sequin CLI](/cli). + If you need to connect to a local dev database, flip the **use localhost** switch and follow the instructions to create a tunnel using the [Sequin CLI](https://sequinstream.com/docs/cli). 3. Follow the instructions to create a publication and a replication slot by running two SQL commands in your database: @@ -219,14 +217,14 @@ You'll now configure Sequin to send every row in your `posts` table to your Trig Sequin will connect to your database and ensure that it's configured properly. - If you need step-by-step connection instructions to connect Sequin to your database, check out our [quickstart guide](/quickstart). + If you need step-by-step connection instructions to connect Sequin to your database, check out our [quickstart guide](https://sequinstream.com/docs/quickstart). Now, create a tunnel to your local endpoint so Sequin can deliver change payloads to your local API: 1. In the Sequin console, open the **HTTP Endpoint** tab and click the **Create HTTP Endpoint** button. - 2. Enter a name for your endpoint (i.e. `local_endpoint`) and flip the **Use localhost** switch. Follow the instructions in the Sequin console to [install the Sequin CLI](/cli), then run: + 2. Enter a name for your endpoint (i.e. `local_endpoint`) and flip the **Use localhost** switch. Follow the instructions in the Sequin console to [install the Sequin CLI](https://sequinstream.com/docs/cli), then run: ```bash sequin tunnel --ports=3001:local_endpoint @@ -297,7 +295,7 @@ You'll now configure Sequin to send every row in your `posts` table to your Trig ``` - Finally, in the Trigger.dev dashboard, navigate to the [**Runs**](https://trigger.dev/runs) tab and confirm that the task run completed successfully: + Finally, in the [**Trigger.dev dashboard**](https://cloud.trigger.dev/), navigate to the Runs page and confirm that the task run completed successfully: Task run diff --git a/docs/images/sequin-intro.png b/docs/images/sequin-intro.png new file mode 100644 index 0000000000..4be9cad73e Binary files /dev/null and b/docs/images/sequin-intro.png differ diff --git a/docs/images/sequin-intro.svg b/docs/images/sequin-intro.svg deleted file mode 100644 index 9d31a9415e..0000000000 --- a/docs/images/sequin-intro.svg +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - - - -INSERT - posts -INTO - - - - -W A L - - - - - - - - -Update -posts -set - - - - -W A L - - - - - - - - - - - -Capture & Send Webhook - - - - - - - - - - - - - - - - - - - -Trigger job via API route - - - - - - - - -Create Embedding - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/mint.json b/docs/mint.json index e275bde843..06dde211f3 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -257,9 +257,7 @@ "guides/frameworks/bun", "guides/frameworks/nextjs", "guides/frameworks/nodejs", - "guides/frameworks/prisma", "guides/frameworks/remix", - "guides/frameworks/sequin", { "group": "Supabase", "icon": "bolt", @@ -272,6 +270,10 @@ } ] }, + { + "group": "Guides", + "pages": ["guides/frameworks/prisma", "guides/frameworks/sequin"] + }, { "group": "Example tasks", "pages": [ diff --git a/docs/snippets/card-sequin.mdx b/docs/snippets/card-sequin.mdx deleted file mode 100644 index 058d0e6eee..0000000000 --- a/docs/snippets/card-sequin.mdx +++ /dev/null @@ -1,9 +0,0 @@ - - - -} -href="/guides/frameworks/sequin" - -/> \ No newline at end of file