Added use cases section in the docs #2641
Conversation
|
WalkthroughThis PR makes two types of changes: (1) stylistic/syntactic formatting tweaks in apps/webapp/app/v3/services/aiRunFilterService.server.ts (trailing commas and minor formatting within type and constructor signatures; no behavioral change), and (2) adds a new "Use cases" documentation section — new MDX pages under docs/guides/use-cases (overview, data-processing-etl, media-processing, media-generation, marketing), updates docs/guides/introduction.mdx and docs/docs.json, and adds a reusable snippet at docs/snippets/use-cases-cards.mdx. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Areas to inspect closely:
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ 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.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/webapp/app/v3/services/aiRunFilterService.server.ts (1)
1-294: Formatting-only changes unrelated to PR purpose.This file contains only syntactic formatting changes (trailing commas and multi-line formatting) with no functional impact. These changes appear unrelated to the PR's stated objective of adding use cases documentation. If this was automatic formatter output, consider applying it in a separate housekeeping PR to keep documentation changes isolated.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
apps/webapp/app/v3/services/aiRunFilterService.server.ts(10 hunks)docs/docs.json(1 hunks)docs/guides/introduction.mdx(1 hunks)docs/guides/use-cases/data-processing-etl.mdx(1 hunks)docs/guides/use-cases/marketing.mdx(1 hunks)docs/guides/use-cases/media-generation.mdx(1 hunks)docs/guides/use-cases/media-processing.mdx(1 hunks)docs/guides/use-cases/overview.mdx(1 hunks)docs/snippets/use-cases-cards.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations
Files:
apps/webapp/app/v3/services/aiRunFilterService.server.ts
{packages/core,apps/webapp}/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
We use zod a lot in packages/core and in the webapp
Files:
apps/webapp/app/v3/services/aiRunFilterService.server.ts
apps/webapp/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/webapp.mdc)
When importing from @trigger.dev/core in the webapp, never import the root package path; always use one of the documented subpath exports from @trigger.dev/core’s package.json
Files:
apps/webapp/app/v3/services/aiRunFilterService.server.ts
{apps/webapp/app/**/*.server.{ts,tsx},apps/webapp/app/routes/**/*.ts}
📄 CodeRabbit inference engine (.cursor/rules/webapp.mdc)
Access environment variables only via the env export from app/env.server.ts; do not reference process.env directly
Files:
apps/webapp/app/v3/services/aiRunFilterService.server.ts
apps/webapp/app/**/*.ts
📄 CodeRabbit inference engine (.cursor/rules/webapp.mdc)
Modules intended for test consumption under apps/webapp/app/**/*.ts must not read environment variables; accept configuration via options instead
Files:
apps/webapp/app/v3/services/aiRunFilterService.server.ts
🧬 Code graph analysis (1)
apps/webapp/app/v3/services/aiRunFilterService.server.ts (1)
apps/webapp/app/components/runs/v3/RunFilters.tsx (2)
TaskRunListSearchFilters(114-183)TaskRunListSearchFilters(185-185)
🪛 GitHub Actions: 📚 Docs Checks
docs/guides/introduction.mdx
[error] 1-1: Broken link detected: '/guides/use-cases/content-generation'.
🪛 LanguageTool
docs/guides/use-cases/marketing.mdx
[grammar] ~55-~55: Ensure spelling is correct
Context: ...creation platform. ## Example worfklow patterns <Tab title="Drip ema...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/guides/use-cases/media-generation.mdx
[grammar] ~64-~64: Ensure spelling is correct
Context: ....dev. ## Example worfklow patterns <Tab title="AI conten...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/guides/use-cases/data-processing-etl.mdx
[grammar] ~54-~54: Use a hyphen to join words.
Context: ...collection at scale, powering their open source, AI-driven compliance platform. ...
(QB_NEW_EN_HYPHEN)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....dev/customers/midday-customer-story"> Read how Midday use Trigger.dev to sync larg...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~64-~64: Ensure spelling is correct
Context: ...form. ## Example worfklow patterns <Tab title="CSV file...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/guides/use-cases/media-processing.mdx
[grammar] ~43-~43: Ensure spelling is correct
Context: ...verwhelming infrastructure. ## Example worfklow patterns <Tab title="Video tr...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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). (23)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: typecheck / typecheck
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
docs/docs.json (1)
336-345: Navigation structure looks good.The new "Use cases" group is well-positioned in the hierarchy and all five page references appear consistent with the new guide pages added in this PR.
docs/snippets/use-cases-cards.mdx (1)
1-24: Well-structured reusable snippet.The card component is clean and maintainable. Each card has appropriate icons and descriptions, and all href references are consistent with the new use-case pages being added.
docs/guides/use-cases/overview.mdx (1)
1-11: Clean overview page structure.The overview page effectively introduces the use-cases section and correctly utilizes the reusable UseCasesCards component for consistency across the documentation.
docs/guides/introduction.mdx (1)
18-51: Fix broken link on line 32.Line 32 references
/guides/use-cases/content-generationwhich doesn't exist in this PR. Based on the docs.json navigation structure and the use-cases-cards snippet, this should likely be/guides/use-cases/media-generation. Additionally, the card title should be "AI media generation" to match the existing documentation.Apply this diff to fix the broken link and align with the new use-case pages:
<Card - title="Content generation" - href="/guides/use-cases/content-generation" + title="AI media generation" + href="/guides/use-cases/media-generation" > - Create scalable content workflows from single assets to thousands. Generate PDFs, videos, or - social media content with progress tracking and approval steps. + Generate images, videos, audio, documents and other media using AI models. </Card>Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/guides/use-cases/data-processing-etl.mdx (1)
46-62: Reduce repetitive sentence openings in customer story cards.Three consecutive cards open with "Read how…" which creates redundant phrasing. Consider varying the sentence structure to improve readability.
Example revision:
<Card title="MagicSchool AI customer story" href="https://trigger.dev/customers/magicschool-ai-customer-story"> -Read how MagicSchool AI uses Trigger.dev to generate insights from millions of student interactions. +MagicSchool AI uses Trigger.dev to generate insights from millions of student interactions. </Card> <Card title="Comp AI customer story" href="https://trigger.dev/customers/comp-ai-customer-story"> -Read how Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open-source, AI-driven compliance platform. +Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open-source, AI-driven compliance platform. </Card> <Card title="Midday customer story" href="https://trigger.dev/customers/midday-customer-story"> -Read how Midday uses Trigger.dev to sync large volumes of bank transactions in their financial management platform. +Midday uses Trigger.dev to sync large volumes of bank transactions in their financial management platform. </Card>docs/guides/use-cases/marketing.mdx (1)
61-73: Maintain consistency with existing documentation pattern.The
<div align="center">wrapper is deprecated HTML, but your code follows the established pattern used consistently across the documentation (also found inmedia-generation.mdx,data-processing-etl.mdx, andmedia-processing.mdx). Keeping this pattern maintains consistency. If a documentation-wide modernization to CSS-based alignment is planned, coordinate the update across all files.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/guides/use-cases/data-processing-etl.mdx(1 hunks)docs/guides/use-cases/marketing.mdx(1 hunks)docs/guides/use-cases/media-generation.mdx(1 hunks)docs/guides/use-cases/media-processing.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/guides/use-cases/media-processing.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/guides/use-cases/media-generation.mdx
🧰 Additional context used
🪛 LanguageTool
docs/guides/use-cases/data-processing-etl.mdx
[grammar] ~54-~54: Use a hyphen to join words.
Context: ...collection at scale, powering their open source, AI-driven compliance platform. ...
(QB_NEW_EN_HYPHEN)
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....dev/customers/midday-customer-story"> Read how Midday use Trigger.dev to sync larg...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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). (16)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: typecheck / typecheck
🔇 Additional comments (6)
docs/guides/use-cases/data-processing-etl.mdx (1)
1-157: LGTM on overall structure and content.The documentation is well-organized with clear sections, practical examples via Mermaid diagrams, and good use of the UseCasesCards component. The featured examples, benefits, and workflow patterns provide solid guidance for users. After addressing the minor grammar and style issues noted above, this should be ready.
docs/guides/use-cases/marketing.mdx (5)
1-11: Well-structured documentation page.The front matter, import of the reusable component, and overview section are clear and well-written. The description is informative and sets appropriate expectations for the page content.
39-45: Clear and compelling benefits section.The three benefits are well-articulated and directly aligned with Trigger.dev's core strengths (delays without idle costs, guaranteed delivery, scale without limits). Good use of formatting with bold text for emphasis.
55-145: Well-designed workflow patterns with clear Mermaid diagrams.The four example workflow patterns (Drip email campaign, Multi-channel campaigns, AI content with approval, Survey response enrichment) are realistic, well-described, and progressively demonstrate more complex orchestration patterns. The Mermaid diagrams are syntactically correct and effectively visualize the workflows. The descriptions help users understand both the pattern and the underlying coordination logic.
147-147: Component invocation aligns with PR scope.The
<UseCasesCards />component is consistently used across the use-case guides as mentioned in the AI summary.
13-37: Review comment is incorrect—scope mismatch.The review comment claims to verify 4 links but the code snippet provided (lines 13-37) contains only 3. All three guide links in the specified lines exist:
- ✓
/guides/examples/resend-email-sequence- ✓
/guides/example-projects/product-image-generator- ✓
/guides/example-projects/human-in-the-loop-workflowThe fourth link (
https://trigger.dev/customers/icon-customer-story) appears at line 49, outside the reviewed section. The review comment lists concerns unrelated to the code changes in lines 13-37.Likely an incorrect or invalid review comment.
|
|
||
| <Card title="Comp AI customer story" href="https://trigger.dev/customers/comp-ai-customer-story"> | ||
|
|
||
| Read how Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open source, AI-driven compliance platform. |
There was a problem hiding this comment.
Add hyphen to "open source" when used as adjective modifier.
Line 54 should use "open-source" (hyphenated) when modifying "compliance platform."
Apply this diff:
-Read how Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open source, AI-driven compliance platform.
+Read how Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open-source, AI-driven compliance platform.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Read how Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open source, AI-driven compliance platform. | |
| Read how Comp AI uses Trigger.dev to automate evidence collection at scale, powering their open-source, AI-driven compliance platform. |
🧰 Tools
🪛 LanguageTool
[grammar] ~54-~54: Use a hyphen to join words.
Context: ...collection at scale, powering their open source, AI-driven compliance platform. ...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In docs/guides/use-cases/data-processing-etl.mdx around line 54, the phrase
"open source, AI-driven compliance platform" uses "open source" as an adjectival
modifier; change it to the hyphenated form "open-source" so it reads
"open-source, AI-driven compliance platform." Make only this wording change and
keep punctuation and spacing consistent.
|
|
||
| </Card> | ||
| <Card title="Midday customer story" href="https://trigger.dev/customers/midday-customer-story"> | ||
|
|
There was a problem hiding this comment.
Fix verb agreement: "Midday use" → "Midday uses".
Line 58 has a subject-verb agreement error.
Apply this diff:
-Read how Midday use Trigger.dev to sync large volumes of bank transactions in their financial management platform.
+Read how Midday uses Trigger.dev to sync large volumes of bank transactions in their financial management platform.Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[style] ~58-~58: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....dev/customers/midday-customer-story"> Read how Midday use Trigger.dev to sync larg...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🤖 Prompt for AI Agents
In docs/guides/use-cases/data-processing-etl.mdx around line 58, change the
phrase "Midday use" to "Midday uses" to correct subject-verb/noun-number
agreement; update the text at that line so the plural form "uses" is used where
the context refers to multiple or general usages.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/guides/introduction.mdx (1)
18-19: Consider moving the import to the top of the file.In MDX, imports are conventionally placed at the top of the file after frontmatter. While the current placement works, relocating it would align with standard MDX best practices.
Apply this change:
-## Frameworks +import UseCasesCards from "/snippets/use-cases-cards.mdx"; + +## FrameworksAnd remove the import from its current location (line 18).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/introduction.mdx(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Define tasks using task({ id, run, ... }) with a unique id per project
Applied to files:
docs/guides/introduction.mdx
⏰ 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). (23)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
docs/guides/introduction.mdx (1)
44-44: Component integration looks good.The
<UseCasesCards />component is appropriately positioned after the Guides table, providing contextual visibility to featured use cases. The component usage is valid MDX syntax.Please verify that the import path
/snippets/use-cases-cards.mdxresolves correctly and that the component renders without errors in the documentation build.
No description provided.