Skip to content

Add copy prompt #2943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
D-K-P wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add copy prompt #2943

D-K-P wants to merge 2 commits into from
+35 −32

Conversation

@D-K-P
Copy link
Member

@D-K-P D-K-P commented Jan 26, 2026

Closes #

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

Testing

[Describe the steps you took to test this change]

Changelog

[Short description of what has changed]

Screenshots

[Screenshots]

💯

@changeset-bot
Copy link

changeset-bot bot commented Jan 26, 2026

⚠️ No Changeset found

Latest commit: e0df080

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
Copy link
Contributor

coderabbitai bot commented Jan 26, 2026 •
edited
Loading

Walkthrough

This pull request updates two documentation files in the quick-start guide. The first file replaces static introductory content with an interactive Accordion component and restructures step-by-step sections into a unified Steps-based layout. The second file restructures CLI initialization guidance to introduce a choice between Trigger.dev MCP and CLI initialization paths, expanding the CLI workflow with explicit steps while maintaining existing code block snippets. The overall content and task information remain functionally equivalent, with changes focused on presentation structure and user guidance flow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 2
❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is a template with empty placeholders; Testing, Changelog, and Screenshots sections are unfilled, and the issue number is not specified, providing no concrete details about the changes. Fill in all required sections with concrete information: specify the issue number, describe testing steps performed, provide a detailed changelog of modifications, and add relevant screenshots if applicable.
Title check ❓ Inconclusive The title 'Add copy prompt' is vague and does not clearly convey the main changes, which involve restructuring quick-start documentation with an interactive Accordion and updated CLI initialization flow. Use a more descriptive title that captures the primary change, such as 'Restructure quick-start guide with AI prompt accordion and improve CLI initialization flow'.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

🧹 Recent nitpick comments
docs/snippets/step-cli-init.mdx (1)

23-24: Minor formatting inconsistency.

Line 23 uses "Trigger.dev MCP Installs..." without an em-dash, while line 24 uses "CLI — Continue...". Consider adding an em-dash after "MCP" for consistency.

Suggested fix 
-- **Trigger.dev MCP** Installs our [MCP server](/mcp-overview) into your AI coding tools (Claude Code, Cursor, etc.), then lets your AI assistant set up the project for you.
+- **Trigger.dev MCP** — Installs our [MCP server](/mcp-overview) into your AI coding tools (Claude Code, Cursor, etc.), then lets your AI assistant set up the project for you.
📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 825219a and e0df080.

📒 Files selected for processing (2)
  • docs/quick-start.mdx
  • docs/snippets/step-cli-init.mdx
🧰 Additional context used
🧠 Learnings (9)
📚 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
  • docs/snippets/step-cli-init.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/quick-start.mdx
  • docs/snippets/step-cli-init.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 dev` to start the Trigger.dev development server

Applied to files:

  • docs/quick-start.mdx
  • docs/snippets/step-cli-init.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/snippets/step-cli-init.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/snippets/step-cli-init.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/snippets/step-cli-init.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/snippets/step-cli-init.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/snippets/step-cli-init.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/snippets/step-cli-init.mdx
🪛 GitHub Actions: 📚 Docs Checks
docs/snippets/step-cli-init.mdx

[error] 2-2: Mintlify broken-links check failed. Found 2 broken links in this file: /mcp-overview (duplicate). Command: 'npx mintlify@4.0.393 broken-links'.

⏰ 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). (1)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
docs/snippets/step-cli-init.mdx (2)

28-35: CLI workflow steps are well-documented.

The step-by-step breakdown of what the CLI does is clear and helpful for users choosing the traditional CLI path.

23-26: Replace /mcp-overview with /mcp-introduction on lines 23 and 26.

The links to /mcp-overview are broken — this file does not exist. Based on the documentation structure, the correct path is /mcp-introduction, which contains the MCP server setup and configuration information.

⛔ Skipped due to learnings 
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

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 dev` to start the Trigger.dev development server

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

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

Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 1306
File: docs/snippets/useful-next-steps.mdx:4-4
Timestamp: 2024-09-23T13:07:08.455Z
Learning: References to old URLs in `docs/mint.json` may be intentional redirects and should remain as is unless otherwise specified.

Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 1306
File: docs/snippets/useful-next-steps.mdx:4-4
Timestamp: 2024-10-12T01:08:24.066Z
Learning: References to old URLs in `docs/mint.json` may be intentional redirects and should remain as is unless otherwise specified.
docs/quick-start.mdx (2)

11-21: Good addition of AI assistant prompt.

The Accordion with a copyable prompt for AI coding assistants is a nice UX improvement that aligns with the new MCP integration described in the CLI init snippet.

23-40: Steps structure is well-organized.

The unified Steps container with inline Step components and imported snippets creates a clean, guided flow. The titleSize="h3" attribute ensures proper heading hierarchy.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

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 and usage tips.

@vibe-kanban-cloud
Copy link

vibe-kanban-cloud bot commented Jan 26, 2026

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@D-K-P