Skip to content

Commit 3dae5e9

Browse files
committed
add reviewer feedback
1 parent a9ef91e commit 3dae5e9

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

guides/cursor.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,18 @@ We recommend creating project rules for your docs so that all contributors have
1717

1818
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.
1919

20-
## Example project rules
20+
## Example project rule
2121

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.
2323

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.
2932

3033
````
3134
---

0 commit comments

Comments
 (0)