Skip to content

docs: Resend email agent example guide - #5081

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

jackbridger wants to merge 4 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: b2403c5

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: Moderate · up to b2403

The example link does not work yet. Before publishing, merge the example and clarify the production Slack token and webhook setup so readers do not misroute approvals or receive duplicate drafts.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description states the purpose of the change: a new example project guide for the Resend email agent, with a link to the example repository. It lists the changed files (the new guide page, docs.js… Add the missing template sections: 1) "Closes #" or state that no issue applies. 2) The checklist with each item checked or explained (contributing guide, PR title convention, and tests run). 3) A Testing section that lists the steps…
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, registers it in docs.json and the example projects table, and a…
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. Documentation-only edits and deletions within survi…
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, registers it in docs.json and the example projects table, and adds a link in webhooks/sources. The title is short, follows the conventional "docs:" prefix, and names the primary change.

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. 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 states the purpose of the change: a new example project guide for the Resend email agent, with a link to the example repository. It lists the changed files (the new guide page, docs.json registration, and the sentence added to webhooks/sources). It includes a demo video link and a merge-order note. It does not follow the required template. It omits the "Closes #<issue>" line, the checklist (contributing guide, PR title convention, and testing confirmation), the Testing section, the Changelog section, and the Screenshots section. Because the core content is present but most template sections are missing, the check should fail.

Resolution

Add the missing template sections: 1) "Closes #<issue>" or state that no issue applies. 2) The checklist with each item checked or explained (contributing guide, PR title convention, and tests run). 3) A Testing section that lists the steps taken to verify the guide, such as building the docs locally and checking the links. 4) A short Changelog entry. 5) A Screenshots section that shows the rendered guide page or table, or states that no screenshots apply.

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

Actionable comments posted: 1


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: 63c5fd99-7f82-4cad-a507-90d22b204cab
Commits

Reviewing files that changed from the base of the PR and between 4d9e4cf and 5679d36.

Files selected for processing: 1
  • docs/webhooks/sources.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: 3
  • GitHub Check: code-quality / code-quality
  • GitHub Check: Detect changes
  • GitHub Check: Analyze (javascript-typescript)
Additional context used
Code guidelines: 2
docs/AGENTS.md — auto-discovered
.claude/rules/docs-writing.md — auto-discovered
Path-based instructions: 2
Applicability reference: AGENTS.md: # AGENTS.md Docs live in `docs/` as a Mintlify site (MDX format).

CodeRabbit inference engine (docs/AGENTS.md)

Files:

  • docs/webhooks/sources.mdx
Source excerpt: Use Mintlify MDX format.

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

Files:

  • docs/webhooks/sources.mdx

Comment thread docs/webhooks/sources.mdx
@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 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.

Devin Review found 2 new potential issues.

Devin Review

Comment thread docs/guides/example-projects/resend-email-agent.mdx
Comment thread docs/guides/example-projects/resend-email-agent.mdx

@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.

Actionable comments posted: 8


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: 1781fe20-130a-40d2-969c-e95ed4367a8b
Commits

Reviewing files that changed from the base of the PR and between 5679d36 and fc0d584.

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

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

Review details
Context from checks skipped due to timeout: 7
  • GitHub Check: All PR Checks
  • GitHub Check: gate
  • GitHub Check: 🔍 What moved
  • GitHub Check: Analyze (actions)
  • GitHub Check: code-quality / code-quality
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: check-broken-links
Additional context used
Code guidelines: 3
docs/AGENTS.md — auto-discovered
.claude/rules/docs-writing.md — auto-discovered
AGENTS.md — 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/introduction.mdx
  • docs/guides/example-projects/resend-email-agent.mdx
Source excerpt: Use Mintlify MDX format.

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

Files:

  • docs/docs.json
  • docs/guides/introduction.mdx
  • docs/guides/example-projects/resend-email-agent.mdx
Source excerpt: Zod is pinned to a single version across the entire monorepo.

CodeRabbit inference engine (AGENTS.md)

Files:

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

621-621: LGTM!

Comment thread docs/guides/example-projects/resend-email-agent.mdx
Comment thread docs/guides/example-projects/resend-email-agent.mdx
Comment thread docs/guides/example-projects/resend-email-agent.mdx
Comment thread docs/guides/example-projects/resend-email-agent.mdx
Comment thread docs/guides/example-projects/resend-email-agent.mdx Outdated
Comment thread docs/guides/example-projects/resend-email-agent.mdx Outdated
Comment thread docs/guides/introduction.mdx

@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.

Actionable comments posted: 2


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: 942a7ddb-1f44-413f-a543-eeba58268b5f
Commits

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

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; 7 remain after this review.

Review details
Context from checks skipped due to timeout: 2
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: code-quality / code-quality
Additional context used
Code guidelines: 2
docs/AGENTS.md — auto-discovered
.claude/rules/docs-writing.md — auto-discovered
Path-based instructions: 2
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

</Step>
</Steps>

To deploy, run `npx trigger.dev@latest deploy` and set the same environment variables on your production environment. Production has its own `resend` and `slack` endpoints, with their own URLs and secrets: point a Resend webhook and a Slack app at the production URLs, and paste each one's signing secret into the matching production endpoint. Until then, the endpoint shows "Needs secret" on the Webhooks page.

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.

Major · Functional Correctness · Quick win

Use the production Slack app’s bot token.

If a reader creates a separate Slack app for production, copying SLACK_BOT_TOKEN makes production post through the development app. Its interactions then go to the development endpoint. Instruct readers to install the production app and use its bot token. (raw.githubusercontent.com)


Major · Functional Correctness · Quick win

Prevent both environments from processing the same inbox.

If a reader creates a production Resend webhook while the development webhook and pnpm dev remain active, both environments draft each incoming email. The approver receives duplicate drafts and incurs extra model calls. Tell readers to repoint or disable the development webhook, or use a separate inbox. (raw.githubusercontent.com)

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