Added cursor rules docs page #1965
Conversation
|
WalkthroughThis update introduces a new documentation guide on using Cursor rules with Trigger.dev, explaining how to integrate and utilize these rules for task writing within the Cursor AI coding editor. The documentation navigation structure is updated to include the new guide under the "Guides" section, and the order of some existing pages is adjusted. Additionally, the introduction guide is revised to reference the new Cursor rules guide and removes a now-redundant section about Cursor rules. Changes
Possibly related PRs
Suggested reviewers
Poem
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:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
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 (2)
docs/guides/cursor-rules.mdx (2)
49-49: Fix verb spelling in guidance
The term “roll-back” should be the verb phrase “roll back” in this context.- so you can roll-back if something changes unexpectedly. + so you can roll back if something changes unexpectedly.🧰 Tools
🪛 LanguageTool
[grammar] ~49-~49: The word “roll-back” is a noun. The verb is spelled with a space.
Context: ...ab**, and commit frequently, so you can roll-back if something changes unexpectedly. Curs...(NOUN_VERB_CONFUSION)
[style] ~49-~49: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ething changes unexpectedly. Cursor can make changes to multiple files at once, so it's best to...(MAKE_CHANGES)
49-51: Consider rephrasing for conciseness
The sentence on commit frequency is a bit verbose. Tightening it will improve readability.- Cursor can make changes to multiple files at once, so it's best to commit often to keep track of all your changes. + Cursor can modify multiple files at once; commit frequently to track changes clearly.🧰 Tools
🪛 LanguageTool
[grammar] ~49-~49: The word “roll-back” is a noun. The verb is spelled with a space.
Context: ...ab**, and commit frequently, so you can roll-back if something changes unexpectedly. Curs...(NOUN_VERB_CONFUSION)
[style] ~49-~49: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ething changes unexpectedly. Cursor can make changes to multiple files at once, so it's best to...(MAKE_CHANGES)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/docs.json(1 hunks)docs/guides/cursor-rules.mdx(1 hunks)docs/guides/introduction.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/cursor-rules.mdx
[grammar] ~49-~49: The word “roll-back” is a noun. The verb is spelled with a space.
Context: ...ab**, and commit frequently, so you can roll-back if something changes unexpectedly. Curs...
(NOUN_VERB_CONFUSION)
[style] ~49-~49: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ething changes unexpectedly. Cursor can make changes to multiple files at once, so it's best to...
(MAKE_CHANGES)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
docs/docs.json (2)
275-276: AI Agents pages reordered as intended
The entries for"guides/ai-agents/translate-and-refine"and"guides/ai-agents/verify-news-article"have been swapped to reflect the updated guide sequence.
279-279: Inserted new Cursor rules guide
The"guides/cursor-rules"entry is correctly added within the "Guides" group indocs.json, ensuring the new guide will appear in the site navigation.docs/guides/introduction.mdx (1)
28-30: Add Cursor rules entry to Guides table
The new[Cursor rules](/guides/cursor-rules)row has been inserted into the Guides table. Verify that the description accurately represents the guide’s content.
Summary by CodeRabbit
New Features
Documentation