diff --git a/docs/docs.json b/docs/docs.json index 2b2d9b5a9a..061637c984 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -272,10 +272,11 @@ "guides/ai-agents/generate-translate-copy", "guides/ai-agents/route-question", "guides/ai-agents/respond-and-check-content", - "guides/ai-agents/verify-news-article", - "guides/ai-agents/translate-and-refine" + "guides/ai-agents/translate-and-refine", + "guides/ai-agents/verify-news-article" ] }, + "guides/cursor-rules", "guides/frameworks/drizzle", "guides/frameworks/prisma", "guides/frameworks/sequin", diff --git a/docs/guides/cursor-rules.mdx b/docs/guides/cursor-rules.mdx new file mode 100644 index 0000000000..fe22ce72fd --- /dev/null +++ b/docs/guides/cursor-rules.mdx @@ -0,0 +1,51 @@ +--- +title: "Using Cursor with Trigger.dev" +sidebarTitle: "Cursor rules" +description: "This guide shows how to add Cursor rules to a project to help you write Trigger.dev tasks faster and more accurately." +icon: "hexagon" +--- + +## Overview + +[Cursor](https://www.cursor.com/) is a powerful AI coding editor which understands your codebase and can help you write code faster and more accurately. This guide shows you how to add our Cursor rules to your project to help you write Trigger.dev tasks. + +## Prerequisites + +- [Cursor](https://www.cursor.com/) installed on your machine + +## Installing our Cursor rules + +1. Locate the `.cursor/rules` folder in your project root, or click the "add new rule" button in `Cursor Settings` > `Rules`. +2. Download the [writing-tasks.mdc](https://github.com/triggerdotdev/trigger.dev/blob/main/.cursor/rules/writing-tasks.mdc) file and place it in the `.cursor/rules` folder +3. For more help installing Cursor rules, see [Cursor's docs](https://docs.cursor.com/context/rules-for-ai) + +