Updated readmes #2408
Updated readmes #2408
Conversation
|
WalkthroughTwo README files were restructured. packages/cli-v3/README.md adds a branded header, introduces an “About Trigger.dev” section reframing the platform, replaces the MCP Server section with a “CLI documentation” link, adds three CLI commands (preview archive, promote, switch), removes the Cursor tip, and updates Support to point to Discord. packages/trigger-sdk/README.md adds badges and an Examples link, renames and expands the intro to “About Trigger.dev,” introduces Core features and Key Components lists, provides two Getting Started paths (web app or manual setup), and redirects SDK usage to docs. No code or public API signatures changed. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/cli-v3/README.md (1)
12-12: Fix badge alt text: add license nameThe license badge’s alt text is missing the license value. Align with the SDK README and shields best practices.
-[](https://opensource.org/licenses/MIT) +[](https://opensource.org/licenses/MIT)packages/trigger-sdk/README.md (2)
34-34: Remove trailing colon in heading (markdownlint MD026)Heading punctuation is flagged; drop the trailing colon.
-## Key Components: +## Key Components
48-51: Optional: Add a minimal “Quick example” to improve onboardingA tiny code sample helps readers connect the dots faster. Suggest adding a short task example using the v3 import.
## SDK documentation -For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction). +## Quick example + +```ts +import { task } from "trigger.dev/sdk/v3"; + +export const hello = task({ + id: "hello-world", + run: async (payload: { name: string }) => { + console.log(`Hello, ${payload.name}!`); + }, +}); +``` + +For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction).If you’d like, I can adjust the example to match your preferred triggering pattern or include a link to the corresponding docs page.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/cli-v3/README.md(2 hunks)packages/trigger-sdk/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Import Trigger.dev APIs from "trigger.dev/sdk/v3" when writing tasks or related utilities
Applied to files:
packages/cli-v3/README.mdpackages/trigger-sdk/README.md
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Define tasks using task({ id, run, ... }) with a unique id per project
Applied to files:
packages/cli-v3/README.mdpackages/trigger-sdk/README.md
🪛 LanguageTool
packages/cli-v3/README.md
[grammar] ~9-~9: There might be a mistake here.
Context: ...tps://www.npmjs.com/package/trigger.dev) [
[grammar] ~10-~10: There might be a mistake here.
Context: ...://github.com/triggerdotdev/trigger.dev) [
[grammar] ~11-~11: There might be a mistake here.
Context: ...1.svg)](https://www.typescriptlang.org/) [
packages/trigger-sdk/README.md
[grammar] ~9-~9: There might be a mistake here.
Context: .../www.npmjs.com/package/@trigger.dev/sdk) [
[grammar] ~10-~10: There might be a mistake here.
Context: ...://github.com/triggerdotdev/trigger.dev) [
[grammar] ~11-~11: There might be a mistake here.
Context: ...1.svg)](https://www.typescriptlang.org/) [
[grammar] ~29-~29: There might be a mistake here.
Context: ... features - Task creation and execution - CLI for development and deployment - Bui...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...ion - CLI for development and deployment - Build system with extensions - Managemen...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...eployment - Build system with extensions - Management API for runs, schedules, and ...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...nd jobs written in TypeScript/JavaScript - CLI: Commands for login, init, dev, depl...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...I: Commands for login, init, dev, deploy - Build Extensions: Customize builds (Pris...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ze builds (Prisma, Python, FFmpeg, etc.) - Management API: Programmatic control ove...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
packages/trigger-sdk/README.md
34-34: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ 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 (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
packages/cli-v3/README.md (2)
25-28: Reworded “About Trigger.dev” section reads wellGood clarity and alignment with the broader docs refresh. Nicely concisely communicates positioning and core value.
40-42: All CLI doc links verified and resolving (HTTP 200)
All URLs—includingcli-preview-archiveandcli-switch—return 200 OK. Slugs are valid and no normalization is needed.packages/trigger-sdk/README.md (1)
23-26: Updated positioning and value prop look solidThe “About Trigger.dev” section is clear and consistent with the CLI readme. No issues.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
packages/cli-v3/README.md (2)
12-12: Fix license badge alt textAlt text is missing the license name. For consistency with the SDK README and better accessibility, include "MIT" in the label.
-[](https://opensource.org/licenses/MIT) +[](https://opensource.org/licenses/MIT)
25-27: Minor copy edit for clarityTighten phrasing and avoid the extra “the” before “horizontal scaling.”
-Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with full observability, managed queues, and elastic infrastructure which handles the horizontal scaling. +Trigger.dev is an open‑source platform for building and deploying fully managed AI agents and workflows. Write workflows in async TypeScript for everything from simple tasks to long‑running AI agents, heavy media processing, complex real‑time systems, and more—complete with full observability, managed queues, and elastic infrastructure that handles horizontal scaling.packages/trigger-sdk/README.md (2)
34-34: Remove trailing punctuation in heading (markdownlint MD026)“Key Components:” ends with a colon, which triggers MD026. Drop the colon.
-## Key Components: +## Key Components
25-25: Minor copy edit for readabilitySame copy tweak as the CLI README to tighten the sentence and fix “which handles the horizontal scaling.”
-Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with full observability, managed queues, and elastic infrastructure which handles the horizontal scaling. +Trigger.dev is an open‑source platform for building and deploying fully managed AI agents and workflows. Write workflows in async TypeScript for everything from simple tasks to long‑running AI agents, heavy media processing, complex real‑time systems, and more—complete with full observability, managed queues, and elastic infrastructure that handles horizontal scaling.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/cli-v3/README.md(2 hunks)packages/trigger-sdk/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Import Trigger.dev APIs from "trigger.dev/sdk/v3" when writing tasks or related utilities
Applied to files:
packages/trigger-sdk/README.mdpackages/cli-v3/README.md
📚 Learning: 2025-08-18T10:07:17.345Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.345Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Define tasks using task({ id, run, ... }) with a unique id per project
Applied to files:
packages/trigger-sdk/README.mdpackages/cli-v3/README.md
🪛 LanguageTool
packages/trigger-sdk/README.md
[grammar] ~9-~9: There might be a mistake here.
Context: .../www.npmjs.com/package/@trigger.dev/sdk) [
[grammar] ~10-~10: There might be a mistake here.
Context: ...://github.com/triggerdotdev/trigger.dev) [
[grammar] ~11-~11: There might be a mistake here.
Context: ...1.svg)](https://www.typescriptlang.org/) [
[grammar] ~29-~29: There might be a mistake here.
Context: ... features - Task creation and execution - CLI for development and deployment - Bui...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...ion - CLI for development and deployment - Build system with extensions - Managemen...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...eployment - Build system with extensions - Management API for runs, schedules, and ...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...nd jobs written in TypeScript/JavaScript - CLI: Commands for login, init, dev, depl...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...I: Commands for login, init, dev, deploy - Build Extensions: Customize builds (Pris...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ze builds (Prisma, Python, FFmpeg, etc.) - Management API: Programmatic control ove...
(QB_NEW_EN)
packages/cli-v3/README.md
[grammar] ~9-~9: There might be a mistake here.
Context: ...tps://www.npmjs.com/package/trigger.dev) [
[grammar] ~10-~10: There might be a mistake here.
Context: ...://github.com/triggerdotdev/trigger.dev) [
[grammar] ~11-~11: There might be a mistake here.
Context: ...1.svg)](https://www.typescriptlang.org/) [
🪛 markdownlint-cli2 (0.17.2)
packages/trigger-sdk/README.md
34-34: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ 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 (5, 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 / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
packages/cli-v3/README.md (2)
8-9: Badges already target the correct package
The CLI v3 package.json defines"name": "trigger.dev"and the README badges point totrigger.dev. No updates needed here.
40-42: ✅ All CLI doc links resolve correctly; slug patterns match existing docs
All referenced URLs return HTTP 200. The use of-commandson individual command pages and omission on overview/introduction pages reflects the current doc structure—no updates required here.packages/trigger-sdk/README.md (1)
8-13: External links and badges verified
All npm badges inpackages/trigger-sdk/README.mdmatch the package name (@trigger.dev/sdk), and the docs/endpoints (/docs/manual-setup,/docs/introduction, and the npm package page) all return HTTP 200.
No description provided.