Skip to content

docs: Resend email agent example guide - #5081

Queued
jackbridger wants to merge 6 commits into
triggerdotdev:mainfrom
jackbridger:docs/resend-email-agent-example
Queued

jackbridger wants to merge 6 commits into
triggerdotdev:mainfrom
jackbridger:docs/resend-email-agent-example

Conversation

@jackbridger

@jackbridger jackbridger commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Adds an example project guide for the new Resend email agent example (triggerdotdev/examples#157): an AI agent that drafts replies to a Resend inbox and waits for approval in Slack before sending.

  • New page guides/example-projects/resend-email-agent, registered in docs.json and the example projects table. It covers the demo video, how the webhooks and wait tokens fit together, setup steps, and links into the repo.
  • One sentence on webhooks/sources, under the table where resend() is listed, linking to the example.

Demo video, embedded on the page from YouTube: https://www.youtube.com/watch?v=6GjXLwj_dnE

The repo links go live when triggerdotdev/examples#157 merges, so merge that first.

🤖 Generated with Claude Code

@changeset-bot

changeset-bot Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ce04d9b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Walkthrough

The webhook sources page and example projects table now link to a Resend email agent guide. The guide describes drafting replies to a Resend inbox, routing drafts to Slack for approval, and sending approved replies. It also documents webhook setup, wait-token handling, project setup, and deployment.

Priority: Low

Merge Risk: Low · up to ce04d

Readers cannot start the documented example until the companion repository change merges; add a clear warning or use an available revision.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description explains the purpose of the change, the new guide page, the docs.json registration, the one-sentence addition on webhooks/sources, the demo video, and the dependency on triggerdotdev/e… Add the template sections that are missing: a "Closes #" line (or state that no issue applies), the checklist with the contributing guide, title convention, and testing items marked, a Testing section describing how the docs were bui…
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title "docs: Resend email agent example guide" matches the main change. The PR adds a guide page for the Resend email agent example, and the title names that page's subject and type (docs). It fol…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs: Resend email agent example guide" matches the main change. The PR adds a guide page for the Resend email agent example, and the title names that page's subject and type (docs). It follows the conventional prefix style and is short and specific.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description explains the purpose of the change, the new guide page, the docs.json registration, the one-sentence addition on webhooks/sources, the demo video, and the dependency on triggerdotdev/examples#157. However, it does not follow the required template. It omits the "Closes #<issue>" line, the contributing-guide and title-convention checklist items, the Testing section, the Changelog section, and the Screenshots section. The description is mostly complete in substance, but the template structure is largely missing.

Resolution

Add the template sections that are missing: a "Closes #<issue>" line (or state that no issue applies), the checklist with the contributing guide, title convention, and testing items marked, a Testing section describing how the docs were built and checked, a Changelog entry with a short description, and a Screenshots section (or a note that screenshots do not apply, for example a note that the embedded video replaces them).

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@devin-ai-integration devin-ai-integration Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Newer findings are available below. Devin Review posted a newer report on this PR, in addition to the findings presented here.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

coderabbitai[bot]

This comment was marked as resolved.

@jackbridger jackbridger changed the title docs(webhooks): link the Resend email agent example docs: Resend email agent example guide Oct 27, 2026
devin-ai-integration[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

⚠️ Outside diff range comments (1)

Minor · Warn readers that the example is not on main yet. · resend-email-agent.mdx:39-46

docs/guides/example-projects/resend-email-agent.mdx:39-46
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Warn readers that the example is not on main yet.

The linked path returns HTTP 404 while PR #157 is open. The setup then clones triggerdotdev/examples and enters resend-slack-email-agent, so readers cannot follow the documented setup until the PR merges.

Suggested fix
+<Warning>
+  The `resend-slack-email-agent` example is not available on the `main` branch until
+  [PR #157](https://github.com/triggerdotdev/examples/pull/157) merges. Wait for that merge
+  before running the setup commands below.
+</Warning>
+
 <Card

Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ee537158-0b22-4aa6-ab72-d1fe649ced51
Commits

Reviewing files that changed from the base of the PR and between b2403c5 and ce04d9b.

Files selected for processing: 1
  • docs/guides/example-projects/resend-email-agent.mdx

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

Review details
Context from checks skipped due to timeout: 1
  • GitHub Check: Analyze (javascript-typescript)
Additional context used
Code guidelines: 3
docs/AGENTS.md — auto-discovered
.claude/rules/docs-writing.md — auto-discovered
.cursor/rules/writing-tasks.mdc — auto-discovered
Path-based instructions: 3
Applicability reference: AGENTS.md: # AGENTS.md Docs live in `docs/` as a Mintlify site (MDX format).

CodeRabbit inference engine (docs/AGENTS.md)

Files:

  • docs/guides/example-projects/resend-email-agent.mdx
Source excerpt: Use Mintlify MDX format.

CodeRabbit inference engine (.claude/rules/docs-writing.md)

Files:

  • docs/guides/example-projects/resend-email-agent.mdx
Source excerpt: You MUST import from `@trigger.dev/sdk` (NEVER `@trigger.dev/sdk/v3`) Source excerpt: You MUST NEVER use `client.defineJob` Source excerpt: YOU MUST `export` every task, including subtasks Source excerpt: Key points: Each ta...

CodeRabbit inference engine (.cursor/rules/writing-tasks.mdc)

Files:

  • docs/guides/example-projects/resend-email-agent.mdx
Additional comments: 1
docs/guides/example-projects/resend-email-agent.mdx: 1

135-139: LGTM!

@jackbridger
jackbridger added this pull request to the merge queue Oct 28, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants