You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/cursor.mdx
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,15 +17,18 @@ We recommend creating project rules for your docs so that all contributors have
17
17
18
18
Create rules files in the `.cursor/rules` directory of your docs repo. See the [Cursor Rules documentation](https://docs.cursor.com/context/rules) for complete setup instructions.
19
19
20
-
## Example project rules
20
+
## Example project rule
21
21
22
-
This rule provides Cursor with knowledge of frequently used Mintlify components and technical writing best practices. Copy and paste this rule into a `.mdc` file in your `.cursor/rules` directory or adjust it for your documentation.
22
+
This rule provides Cursor with context for frequently used Mintlify components and technical writing best practices.
23
23
24
-
Customize this rule for your project:
25
-
-**Writing standards**: Update language guidelines to match your style guide
26
-
-**Component patterns**: Add project-specific components or modify existing examples
27
-
-**Code examples**: Replace generic examples with real API calls and responses for your product
28
-
-**Style and tone preferences**: Adjust terminology, formatting, and other rules
24
+
You can use this example as-is or customize it for your documentation:
25
+
26
+
***Writing standards**: Update language guidelines to match your style guide.
27
+
***Component patterns**: Add project-specific components or modify existing examples.
28
+
***Code examples**: Replace generic examples with real API calls and responses for your product.
29
+
***Style and tone preferences**: Adjust terminology, formatting, and other rules.
30
+
31
+
Add this rule with any modifications as an `.mdc` file in your `.cursor/rules` directory.
0 commit comments