Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📜 Recent review details⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (27)
WalkthroughUpdated many documentation files: renamed the Realtime navigation label from "React hooks (frontend)" to "React hooks"; added a docs redirect from /guides/frameworks to /guides/frameworks/nextjs; inserted new "Realtime updates with React hooks" sections in Next.js and Remix guides; reframed multiple Realtime pages to separate "run updates" vs "streaming" (frontmatter, titles, descriptions, links, and new FAQs); clarified retry precedence and run metadata wording; expanded Quick Start with AI/triggering guidance and import rules; adjusted task streams/streams wording; and standardized SDK import examples in task-writing rules. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/quick-start.mdx (1)
31-37: Add an explicit server-only warning forTRIGGER_SECRET_KEY.Line 31 introduces the secret key flow; add one sentence that this key must never be exposed to browser/client bundles.
🔐 Suggested wording tweak
-The test page in the dashboard is great for verifying your task works. To trigger tasks from your own code, you'll need to set the `TRIGGER_SECRET_KEY` environment variable. Grab it from the API Keys page in the dashboard and add it to your `.env` file. +The test page in the dashboard is great for verifying your task works. To trigger tasks from your own code, you'll need to set the `TRIGGER_SECRET_KEY` environment variable. Grab it from the API Keys page in the dashboard and add it to your `.env` file. Keep this key server-side only (never expose it in client-side code).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/quick-start.mdx` around lines 31 - 37, Add a one-sentence server-only warning next to the TRIGGER_SECRET_KEY explanation (the paragraph that instructs adding TRIGGER_SECRET_KEY=tr_dev_... to .env) stating that TRIGGER_SECRET_KEY is a secret and must never be exposed in browser/client bundles or committed to source control; place the sentence immediately after the code block or at the end of the paragraph so readers see the server-only restriction in context.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/quick-start.mdx`:
- Around line 31-37: Add a one-sentence server-only warning next to the
TRIGGER_SECRET_KEY explanation (the paragraph that instructs adding
TRIGGER_SECRET_KEY=tr_dev_... to .env) stating that TRIGGER_SECRET_KEY is a
secret and must never be exposed in browser/client bundles or committed to
source control; place the sentence immediately after the code block or at the
end of the paragraph so readers see the server-only restriction in context.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 69adc420-da71-49c9-bab7-246f811f4328
📒 Files selected for processing (18)
docs/docs.jsondocs/errors-retrying.mdxdocs/guides/frameworks/nextjs.mdxdocs/guides/frameworks/remix.mdxdocs/quick-start.mdxdocs/realtime/backend/overview.mdxdocs/realtime/backend/streams.mdxdocs/realtime/backend/subscribe.mdxdocs/realtime/how-it-works.mdxdocs/realtime/overview.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/realtime/react-hooks/triggering.mdxdocs/runs/metadata.mdxdocs/tasks/overview.mdxdocs/tasks/streams.mdxdocs/triggering.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{js,ts,jsx,tsx,json,md,yaml,yml}
📄 CodeRabbit inference engine (AGENTS.md)
Format code using Prettier before committing
Files:
docs/docs.json
docs/**/docs.json
📄 CodeRabbit inference engine (docs/CLAUDE.md)
docs/**/docs.json: Main documentation config must be defined indocs.jsonwhich includes navigation structure, theme, and metadata
Navigation structure indocs.jsonshould be organized usingnavigation.dropdownswith groups and pages
Files:
docs/docs.json
docs/**/*.mdx
📄 CodeRabbit inference engine (docs/CLAUDE.md)
docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from@trigger.dev/sdkin code examples (never from@trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences:typescript,bash,json
Files:
docs/errors-retrying.mdxdocs/realtime/backend/subscribe.mdxdocs/guides/frameworks/remix.mdxdocs/tasks/streams.mdxdocs/realtime/backend/streams.mdxdocs/runs/metadata.mdxdocs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/realtime/backend/overview.mdxdocs/triggering.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/how-it-works.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdxdocs/realtime/overview.mdx
🧠 Learnings (48)
📓 Common learnings
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:19.869Z
Learning: In the triggerdotdev/trigger.dev repository, docs PRs are often written as companions to implementation PRs (e.g., PR `#3200` documents features being added in PR `#3196`). When reviewing docs PRs, the documented features may exist in a companion/companion PR branch rather than main. Always check companion PRs referenced in the PR description before flagging missing implementations.
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: packages/trigger-sdk/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:48.124Z
Learning: Docs updates should typically be done in a separate PR from SDK feature implementation
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `.withStreams()` to subscribe to realtime streams from task metadata in addition to run changes
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Organize documentation across appropriate directories: `documentation/` for core conceptual docs, `guides/` for how-to guides, `config/` for configuration reference, `deployment/` for deployment guides, `tasks/` for task documentation, `realtime/` for real-time features, `runs/` for run management, and `images/` for assets
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Applies to docs/**/docs.json : Navigation structure in `docs.json` should be organized using `navigation.dropdowns` with groups and pages
Applied to files:
docs/docs.json
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: New documentation pages must be added to the navigation structure in `docs.json` under the correct group after creating the MDX file
Applied to files:
docs/docs.json
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Applies to docs/**/docs.json : Main documentation config must be defined in `docs.json` which includes navigation structure, theme, and metadata
Applied to files:
docs/docs.json
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Use `useRun`, `useRealtimeRun` and other SWR/realtime hooks from `trigger.dev/react-hooks` for data fetching
Applied to files:
docs/docs.jsondocs/guides/frameworks/remix.mdxdocs/guides/frameworks/nextjs.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/realtime/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Use `trigger.dev/react-hooks` package for realtime subscriptions in React components
Applied to files:
docs/docs.jsondocs/guides/frameworks/remix.mdxdocs/guides/frameworks/nextjs.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/realtime/overview.mdx
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Organize documentation across appropriate directories: `documentation/` for core conceptual docs, `guides/` for how-to guides, `config/` for configuration reference, `deployment/` for deployment guides, `tasks/` for task documentation, `realtime/` for real-time features, `runs/` for run management, and `images/` for assets
Applied to files:
docs/docs.json
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Configure task retry behavior using the `retry` property with options like maxAttempts, factor, and timeout values
Applied to files:
docs/errors-retrying.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger.config.ts : Configure global retry settings in trigger.config.ts using `retries` object with defaults for all tasks
Applied to files:
docs/errors-retrying.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger.config.ts : Configure Trigger.dev project in `trigger.config.ts` using `defineConfig()` with project ref and task directories
Applied to files:
docs/errors-retrying.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger.config.ts : Define global lifecycle functions (onStart, onSuccess, onFailure) in trigger.config.ts to apply to all tasks
Applied to files:
docs/errors-retrying.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use the `task()` function from `trigger.dev/sdk/v3` to define tasks with id and run properties
Applied to files:
docs/errors-retrying.mdxdocs/guides/frameworks/remix.mdxdocs/tasks/streams.mdxdocs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/realtime/backend/overview.mdxdocs/triggering.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdxdocs/realtime/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `yourTask.trigger()` to trigger a task from inside another task with specified payload
Applied to files:
docs/errors-retrying.mdxdocs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger.config.ts : Set default machine configuration in trigger.config.ts using `defaultMachine` property
Applied to files:
docs/errors-retrying.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Limit task duration using the `maxDuration` property (in seconds)
Applied to files:
docs/errors-retrying.mdxdocs/tasks/overview.mdx
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.
Applied to files:
docs/errors-retrying.mdxdocs/realtime/backend/subscribe.mdxdocs/guides/frameworks/remix.mdxdocs/tasks/streams.mdxdocs/realtime/backend/streams.mdxdocs/runs/metadata.mdxdocs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/realtime/backend/overview.mdxdocs/triggering.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/how-it-works.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdxdocs/realtime/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Subscribe to run updates using `runs.subscribeToRun()` for realtime monitoring of task execution
Applied to files:
docs/realtime/backend/subscribe.mdxdocs/guides/frameworks/remix.mdxdocs/tasks/streams.mdxdocs/realtime/backend/streams.mdxdocs/guides/frameworks/nextjs.mdxdocs/realtime/backend/overview.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/how-it-works.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdxdocs/realtime/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `runs.subscribeToBatch()` to subscribe to changes for all runs in a batch
Applied to files:
docs/realtime/backend/subscribe.mdxdocs/guides/frameworks/nextjs.mdxdocs/realtime/backend/overview.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/realtime/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `.withStreams()` to subscribe to realtime streams from task metadata in addition to run changes
Applied to files:
docs/realtime/backend/subscribe.mdxdocs/guides/frameworks/remix.mdxdocs/tasks/streams.mdxdocs/realtime/backend/streams.mdxdocs/runs/metadata.mdxdocs/guides/frameworks/nextjs.mdxdocs/realtime/backend/overview.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/streams.mdxdocs/realtime/how-it-works.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/realtime/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `runs.subscribeToRunsWithTag()` to subscribe to all runs with a specific tag
Applied to files:
docs/realtime/backend/subscribe.mdxdocs/guides/frameworks/nextjs.mdxdocs/realtime/backend/overview.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/realtime/overview.mdx
📚 Learning: 2026-03-25T00:18:24.123Z
Learnt from: isshaddad
Repo: triggerdotdev/trigger.dev PR: 3262
File: docs/guides/frameworks/nango.mdx:71-71
Timestamp: 2026-03-25T00:18:24.123Z
Learning: In trigger.dev framework guide MDX files under docs/guides/frameworks/**, when you include TypeScript code snippets, use the code-fence language tag `ts` (not `typescript`) for the opening ``` fence. Keep this consistent across all framework guides so syntax highlighting works uniformly (e.g., Next.js, Sequin, Prisma, Remix, Drizzle).
Applied to files:
docs/guides/frameworks/remix.mdxdocs/guides/frameworks/nextjs.mdx
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Applies to docs/**/*.mdx : Always import from `trigger.dev/sdk` in code examples (never from `trigger.dev/sdk/v3`)
Applied to files:
docs/guides/frameworks/remix.mdxdocs/guides/frameworks/nextjs.mdx
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Applies to docs/**/*.mdx : Use Mintlify components for structured content: <Note>, <Warning>, <Info>, <Tip>, <CodeGroup>, <Expandable>, <Steps>/<Step>, <Card>/<CardGroup>
Applied to files:
docs/guides/frameworks/remix.mdx
📚 Learning: 2025-11-27T16:26:58.661Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-11-27T16:26:58.661Z
Learning: Applies to apps/webapp/**/*.{ts,tsx} : Follow the Remix 2.1.0 and Express server conventions when updating the main trigger.dev webapp
Applied to files:
docs/guides/frameworks/remix.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Attach metadata to task runs using the metadata option when triggering, and access/update it inside runs using metadata functions
Applied to files:
docs/guides/frameworks/remix.mdxdocs/runs/metadata.mdxdocs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/realtime/backend/overview.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdxdocs/realtime/overview.mdx
📚 Learning: 2026-03-23T06:24:25.029Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: apps/webapp/CLAUDE.md:0-0
Timestamp: 2026-03-23T06:24:25.029Z
Learning: Applies to apps/webapp/app/routes/**/*.ts : Use Remix flat-file route convention with dot-separated segments where `api.v1.tasks.$taskId.trigger.ts` maps to `/api/v1/tasks/:taskId/trigger`
Applied to files:
docs/guides/frameworks/remix.mdx
📚 Learning: 2025-11-27T16:26:37.432Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-27T16:26:37.432Z
Learning: The webapp at apps/webapp is a Remix 2.1 application using Node.js v20
Applied to files:
docs/guides/frameworks/remix.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `tasks.batchTrigger()` to trigger multiple runs of a single task with different payloads
Applied to files:
docs/guides/frameworks/remix.mdxdocs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use metadata methods (set, del, replace, append, remove, increment, decrement, stream, flush) to update metadata during task execution
Applied to files:
docs/runs/metadata.mdx
📚 Learning: 2026-03-02T12:43:37.906Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: packages/core/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:37.906Z
Learning: Exercise caution with changes to trigger.dev/core as they affect both the customer-facing SDK and server-side webapp - breaking changes can impact deployed user tasks and the platform simultaneously
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/triggering.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `tasks.trigger()` with type-only imports to trigger tasks from backend code without importing the task implementation
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Generate example payloads for tasks when possible
Applied to files:
docs/guides/frameworks/nextjs.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `yourTask.batchTrigger()` to trigger multiple runs of a task from inside another task
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/triggering.mdxdocs/realtime/react-hooks/subscribe.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `yourTask.triggerAndWait()` to trigger a task and wait for its result from a parent task
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/quick-start.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `batch.trigger()` to trigger multiple different tasks at once from backend code
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/triggering.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `batch.triggerByTask()` to batch trigger tasks by passing task instances for static task sets
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/triggering.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `batch.triggerByTaskAndWait()` to batch trigger tasks by passing task instances and wait for results
Applied to files:
docs/guides/frameworks/nextjs.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Use `TriggerAuthContext` provider to supply Public Access Token to Trigger.dev React hooks
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/realtime/react-hooks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use lifecycle functions (init, cleanup, onStart, onSuccess, onFailure, handleError) for task event handling
Applied to files:
docs/guides/frameworks/nextjs.mdxdocs/realtime/react-hooks/overview.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `schedules.task()` for scheduled/cron tasks instead of regular `task()`
Applied to files:
docs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/triggering.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `trigger.dev/sdk/v3` for all imports in Trigger.dev tasks
Applied to files:
docs/quick-start.mdxdocs/triggering.mdxdocs/realtime/react-hooks/overview.mdxdocs/realtime/react-hooks/triggering.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Use environment variable TRIGGER_SECRET_KEY when triggering tasks from backend code
Applied to files:
docs/quick-start.mdxdocs/triggering.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Export tasks with unique IDs within the project to enable proper task discovery and execution
Applied to files:
docs/quick-start.mdx
📚 Learning: 2026-03-23T06:24:14.566Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-23T06:24:14.566Z
Learning: Applies to **/*.{ts,tsx} : When writing Trigger.dev tasks, always import from `trigger.dev/sdk` - never use `trigger.dev/sdk/v3` or deprecated `client.defineJob`
Applied to files:
docs/quick-start.mdxdocs/triggering.mdxdocs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Run `npx trigger.devlatest init` to initialize a Trigger.dev project
Applied to files:
docs/quick-start.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `idempotencyKeys.create()` to create idempotency keys for preventing duplicate task executions
Applied to files:
docs/triggering.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `schemaTask()` from `trigger.dev/sdk/v3` with Zod schema for payload validation
Applied to files:
docs/tasks/overview.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use logger methods (debug, log, info, warn, error) from `trigger.dev/sdk/v3` for structured logging in tasks
Applied to files:
docs/tasks/overview.mdx
🔇 Additional comments (24)
docs/errors-retrying.mdx (1)
15-16: LGTM! Clear clarification of retry configuration hierarchy.This note helpfully clarifies the precedence of task-level retry settings over global defaults, which aligns with the related clarification in the tasks overview documentation.
docs/docs.json (2)
140-140: LGTM! Cleaner navigation label.Simplifying "React hooks (frontend)" to "React hooks" reduces redundancy since the context is already clear from the Realtime section.
645-648: LGTM! Sensible redirect for frameworks landing page.Redirecting
/guides/frameworksto/guides/frameworks/nextjsprovides a reasonable default destination. Next.js is a popular framework choice for Trigger.dev users.docs/guides/frameworks/nextjs.mdx (1)
435-447: LGTM! Helpful addition of Realtime documentation links.The new section provides clear guidance for Next.js developers wanting to use React hooks for real-time updates. The CardGroup layout is consistent with the Mintlify component patterns used elsewhere in the docs.
docs/triggering.mdx (1)
32-34: LGTM! Excellent clarification on trigger pattern selection.This note directly addresses a common source of confusion for developers. The guidance is clear: use
yourTask.trigger()for type safety when possible, andtasks.trigger()when you need to avoid bundling task code (a real concern in Next.js). Based on learnings: "Usetasks.trigger()with type-only imports to trigger tasks from backend code without importing the task implementation."docs/guides/frameworks/remix.mdx (1)
200-211: LGTM! Consistent Realtime section for Remix users.The new section mirrors the structure added to the Next.js guide, ensuring consistent documentation across framework guides. The placement before "Additional resources" maintains good page flow.
docs/runs/metadata.mdx (1)
4-9: LGTM! More actionable metadata documentation.The updated description and intro clearly communicate the key capabilities: structured data attachment, real-time subscriber updates, and common use cases. The 256KB limit is appropriately mentioned upfront.
docs/realtime/backend/subscribe.mdx (1)
2-7: LGTM! Clearer framing of backend subscription capabilities.The renamed title "Run updates (backend)" and updated description better communicate what this API provides: status, metadata, and tag change notifications via async iterators. This aligns well with the PR's goal of distinguishing run updates from streaming.
docs/realtime/react-hooks/triggering.mdx (1)
2-7: LGTM! More descriptive title and introduction.The updated title "Trigger tasks from React" is clearer than the generic "Trigger hooks." The expanded description covers the full capability set: triggering, progress subscription, and streaming output.
docs/realtime/backend/streams.mdx (1)
2-4: Clear reframe and link updates for backend streaming docs.The updated title/description and intro/note copy make the page intent much clearer and keep navigation focused on emit-vs-consume paths.
Also applies to: 7-10
docs/tasks/streams.mdx (1)
2-4: Terminology and positioning are improved.Good update to distinguish stream data from run-state subscriptions while keeping the page entry points intuitive.
Also applies to: 7-10, 19-19
docs/quick-start.mdx (1)
43-53: Next-step card copy is clearer and more action-oriented.These text tweaks improve scannability and make the quick-start follow-up flow easier to navigate.
docs/realtime/backend/overview.mdx (1)
2-4: Strong overview restructure for backend realtime.The new category table makes the run-updates vs streaming distinction immediately clear and improves discoverability of the right guide.
Also applies to: 9-20
docs/realtime/how-it-works.mdx (1)
2-4: Scope and architecture messaging are clearer.Nice tightening of this page around run updates specifically, with a clear pointer to streaming as a separate transport.
Also applies to: 7-11
docs/tasks/overview.mdx (2)
67-67: Retry behavior documentation is much clearer.Good clarification of when retries occur and the added options table/precedence note improves operator understanding.
Also applies to: 87-95
158-159: Lifecycle hook naming update is consistent and helpful.Switching these examples to
tasks.onStartAttempt(...)aligns this section with current lifecycle terminology.Also applies to: 173-174, 178-179
docs/realtime/react-hooks/overview.mdx (1)
2-4: React hooks overview is now easier to navigate.Great improvement in categorizing hook families and clarifying when to use Realtime vs SWR hooks.
Also applies to: 9-10, 58-63, 67-73
docs/realtime/react-hooks/subscribe.mdx (1)
2-4: Excellent run-updates framing and practical FAQ additions.The updated intro + section naming are clearer, and the FAQ directly answers key implementation questions teams usually hit.
Also applies to: 7-19, 657-674
docs/realtime/react-hooks/streams.mdx (3)
1-11: Well-structured frontmatter and clear introductory framing.The frontmatter includes all required fields (title, description, sidebarTitle). The opening paragraph on line 7 effectively establishes the distinction between streaming hooks and progress/status hooks, immediately orienting readers to the right section.
24-51: Complete and type-safe code examples.The basic usage and defined streams examples are well-structured with proper TypeScript typing,
"use client"directives for RSC compatibility, and error/loading state handling. Good progression from basic to typed usage.Also applies to: 57-90
433-449: Helpful FAQ section with good cross-references.The FAQ addresses common user questions and links to relevant documentation pages. The distinction between streaming and run updates on lines 439-441 is particularly valuable for guiding users to the right approach.
docs/realtime/overview.mdx (3)
1-21: Excellent comparison table for user orientation.The comparison table on lines 13-20 clearly distinguishes Run updates from Streaming across multiple dimensions (what you get, when it fires, use case, React hook, setup requirements, infrastructure). This will significantly help users choose the right approach for their needs.
24-45: Clear section structure with appropriate cross-linking.The Run updates and Streaming sections are concise and link to the detailed documentation. The authentication note on line 45 appropriately directs users to the auth guide without duplicating content.
47-63: Practical FAQ section addressing common concerns.The FAQ entries cover realistic user questions with actionable guidance. Line 59's clarification that users don't need to worry about WebSockets or polling is particularly reassuring for those unfamiliar with the underlying infrastructure.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
2 participants
No description provided.