Skip to content

Commit fff1c0a

Browse files
authored
Sequin guide updates (#1371)
* Updated intro image style to match trigger style * Typo fix * Added some urls + a few copy fixes * Added a new Guides side menu section
1 parent 7d11123 commit fff1c0a

File tree

6 files changed

+11
-168
lines changed

6 files changed

+11
-168
lines changed

docs/guides/frameworks/introduction.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,11 @@ import CardNodejs from "/snippets/card-nodejs.mdx";
1010
import CardNextjs from "/snippets/card-nextjs.mdx";
1111
import CardRemix from "/snippets/card-remix.mdx";
1212
import CardSupabase from "/snippets/card-supabase.mdx";
13-
import CardSequin from "/snippets/card-sequin.mdx";
1413

1514
<CardGroup cols={3}>
1615
<CardBun />
1716
<CardNodejs />
1817
<CardNextjs />
1918
<CardRemix />
20-
<CardSequin />
2119
<CardSupabase />
22-
2320
</CardGroup>

docs/guides/frameworks/sequin.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ icon: "database"
99

1010
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:
1111

12-
<Frame>
13-
<img src="/images/sequin-intro.svg" alt="Sequin and Trigger.dev Overview" />
14-
</Frame>
12+
<img src="/images/sequin-intro.png" alt="Sequin and Trigger.dev Overview" />
1513

1614
In this guide, you'll learn how to use Sequin to trigger Trigger.dev tasks from database changes.
1715

@@ -119,7 +117,7 @@ Start by creating a new Trigger.dev task that takes in a Sequin change event as
119117
```
120118
</CodeGroup>
121119

122-
This task takes in a Sequin record event, creates an embedding, and then uppserts the embedding into a `post_embeddings` table.
120+
This task takes in a Sequin record event, creates an embedding, and then upserts the embedding into a `post_embeddings` table.
123121
</Step>
124122
<Step title="Add the task to your Trigger.dev project">
125123
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
184182
DATABASE_URL=postgresql://
185183
```
186184

187-
The `SEQUIN_WEBHOOK_SECRET` ensures that only Sequin can access your APIendpoint.
185+
The `SEQUIN_WEBHOOK_SECRET` ensures that only Sequin can access your API endpoint.
188186

189187
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.
190188

@@ -205,7 +203,7 @@ You'll now configure Sequin to send every row in your `posts` table to your Trig
205203
1. Login to your Sequin account and click the **Add New Database** button.
206204
2. Enter the connection details for your Postgres database.
207205
<Info>
208-
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).
206+
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).
209207
</Info>
210208
3. Follow the instructions to create a publication and a replication slot by running two SQL commands in your database:
211209

@@ -219,14 +217,14 @@ You'll now configure Sequin to send every row in your `posts` table to your Trig
219217
Sequin will connect to your database and ensure that it's configured properly.
220218

221219
<Note>
222-
If you need step-by-step connection instructions to connect Sequin to your database, check out our [quickstart guide](/quickstart).
220+
If you need step-by-step connection instructions to connect Sequin to your database, check out our [quickstart guide](https://sequinstream.com/docs/quickstart).
223221
</Note>
224222
</Step>
225223
<Step title="Tunnel to your local endpoint">
226224
Now, create a tunnel to your local endpoint so Sequin can deliver change payloads to your local API:
227225

228226
1. In the Sequin console, open the **HTTP Endpoint** tab and click the **Create HTTP Endpoint** button.
229-
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:
227+
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:
230228

231229
```bash
232230
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
297295
```
298296
</Step>
299297
<Step title="Observe the task run in the Trigger.dev dashboard">
300-
Finally, in the Trigger.dev dashboard, navigate to the [**Runs**](https://trigger.dev/runs) tab and confirm that the task run completed successfully:
298+
Finally, in the [**Trigger.dev dashboard**](https://cloud.trigger.dev/), navigate to the Runs page and confirm that the task run completed successfully:
301299

302300
<Frame>
303301
<img src="/images/sequin-final-run.png" alt="Task run" />

docs/images/sequin-intro.png

47.1 KB
Loading

0 commit comments

Comments
 (0)