Skip to content

Commit a32affa

Browse files
committed
remove .cursorrules & add .cursor/rules
.cursorrules has been deprecated in favour of .mdc format for rules within .cursor/rules directory remove deprecated .cursorrules split rules into separate .mdc files
1 parent d2648e4 commit a32affa

File tree

5 files changed

+133
-107
lines changed

5 files changed

+133
-107
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
description: Standards for OpenAPI specifications and API code samples
3+
globs: ["apify-api/**/*.yaml", "apify-api/**/*.js"]
4+
alwaysApply: true
5+
---
6+
7+
# API Documentation Rules
8+
9+
## OpenAPI specifications
10+
11+
- Follow **RESTful conventions** for endpoint design
12+
- Use **descriptive operation IDs** following camelCase
13+
- Include **comprehensive examples** for all endpoints
14+
- Provide **clear parameter descriptions**
15+
16+
## Code samples
17+
18+
- Include examples in **multiple languages** (JavaScript, Python, cURL)
19+
- Use **realistic data** in examples
20+
- Show **error handling** where appropriate
21+
- Include **authentication examples**
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
description: Content formatting standards for MDX files and code examples
3+
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4+
alwaysApply: true
5+
---
6+
7+
# Content Formatting Rules
8+
9+
## Front matter (MDX files)
10+
11+
```yaml
12+
---
13+
title: "Clear, action-oriented title"
14+
description: "140-160 character description that explains the value"
15+
sidebar_position: 1
16+
slug: /path/to/page
17+
---
18+
```
19+
20+
## Text emphasis
21+
22+
- **Bold** for UI elements, buttons, menu items
23+
- *Italics* for emphasis and new terms
24+
- `code` for inline code, file names, paths, variables
25+
- Use code blocks with language specification for examples
26+
27+
## Admonitions
28+
29+
Use admonitions to highlight important information:
30+
31+
```markdown
32+
:::note Important information
33+
Your note content here.
34+
:::
35+
36+
:::tip Pro tip
37+
Helpful tip for users.
38+
:::
39+
40+
:::info Additional context
41+
Background information.
42+
:::
43+
44+
:::caution Warning
45+
Something to be careful about.
46+
:::
47+
48+
:::danger Critical
49+
Critical information that could cause issues.
50+
:::
51+
```
52+
53+
## Code examples
54+
55+
- Use **code tabs** for multiple language examples
56+
- Include **complete, runnable examples**
57+
- Add **comments** to explain complex code
58+
- Use **syntax highlighting** for all code blocks

.cursorrules renamed to .cursor/rules/documentation-style.mdc

Lines changed: 7 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Apify documentation - cursor rules
1+
---
2+
description: Documentation style guidelines and writing standards for Apify docs
3+
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4+
alwaysApply: true
5+
---
6+
7+
# Documentation Style Guidelines
28

39
## Project overview
410

@@ -40,112 +46,6 @@ This is the Apify documentation repository containing platform documentation, ac
4046
- Use **numbered lists** for sequential steps
4147
- Use **bullet points** for non-sequential items
4248

43-
## Content formatting
44-
45-
### Front matter (MDX files)
46-
47-
```yaml
48-
---
49-
title: "Clear, action-oriented title"
50-
description: "140-160 character description that explains the value"
51-
sidebar_position: 1
52-
slug: /path/to/page
53-
---
54-
```
55-
56-
### Text emphasis
57-
58-
- **Bold** for UI elements, buttons, menu items
59-
- *Italics* for emphasis and new terms
60-
- `code` for inline code, file names, paths, variables
61-
- Use code blocks with language specification for examples
62-
63-
### Admonitions
64-
65-
Use admonitions to highlight important information:
66-
67-
```markdown
68-
:::note Important information
69-
Your note content here.
70-
:::
71-
72-
:::tip Pro tip
73-
Helpful tip for users.
74-
:::
75-
76-
:::info Additional context
77-
Background information.
78-
:::
79-
80-
:::caution Warning
81-
Something to be careful about.
82-
:::
83-
84-
:::danger Critical
85-
Critical information that could cause issues.
86-
:::
87-
```
88-
89-
### Code examples
90-
91-
- Use **code tabs** for multiple language examples
92-
- Include **complete, runnable examples**
93-
- Add **comments** to explain complex code
94-
- Use **syntax highlighting** for all code blocks
95-
96-
## File organization
97-
98-
### Naming conventions
99-
100-
- Use **kebab-case** for file names: `web-scraping-basics.md`
101-
- Use **descriptive names** that reflect content
102-
- Group related files in **logical directories**
103-
104-
### Directory structure
105-
106-
```text
107-
sources/
108-
├── platform/ # Platform documentation
109-
│ ├── actors/ # Actor-related content
110-
│ ├── storage/ # Storage documentation
111-
│ └── integrations/ # Integration guides
112-
└── academy/ # Educational content
113-
├── tutorials/ # Step-by-step guides
114-
├── webscraping/ # Web scraping courses
115-
└── glossary/ # Terminology and definitions
116-
```
117-
118-
## API documentation
119-
120-
### OpenAPI specifications
121-
122-
- Follow **RESTful conventions** for endpoint design
123-
- Use **descriptive operation IDs** following camelCase
124-
- Include **comprehensive examples** for all endpoints
125-
- Provide **clear parameter descriptions**
126-
127-
### Code samples
128-
129-
- Include examples in **multiple languages** (JavaScript, Python, cURL)
130-
- Use **realistic data** in examples
131-
- Show **error handling** where appropriate
132-
- Include **authentication examples**
133-
134-
## Quality standards
135-
136-
### Content quality guidelines
137-
138-
When creating or editing content, ensure:
139-
140-
- [ ] Content follows Microsoft style guide (sentence case headings, proper emphasis)
141-
- [ ] Front matter includes proper title, description, and metadata
142-
- [ ] Code examples are complete and include proper syntax highlighting
143-
- [ ] All links use descriptive text (avoid "click here")
144-
- [ ] Images include meaningful alt text
145-
- [ ] Content uses inclusive language and active voice
146-
- [ ] Headings follow proper hierarchy (H1 → H2 → H3)
147-
- [ ] Content is clear, concise, and action-oriented
148-
14949
## Common patterns
15050

15151
### Tutorial structure
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
description: File naming conventions and directory structure standards
3+
globs: ["sources/**/*"]
4+
alwaysApply: true
5+
---
6+
7+
# File Organization Rules
8+
9+
## Naming conventions
10+
11+
- Use **kebab-case** for file names: `web-scraping-basics.md`
12+
- Use **descriptive names** that reflect content
13+
- Group related files in **logical directories**
14+
15+
## Directory structure
16+
17+
```text
18+
sources/
19+
├── platform/ # Platform documentation
20+
│ ├── actors/ # Actor-related content
21+
│ ├── storage/ # Storage documentation
22+
│ └── integrations/ # Integration guides
23+
└── academy/ # Educational content
24+
├── tutorials/ # Step-by-step guides
25+
├── webscraping/ # Web scraping courses
26+
└── glossary/ # Terminology and definitions
27+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
description: Content quality checklist and review standards
3+
globs: ["sources/**/*.md", "sources/**/*.mdx"]
4+
alwaysApply: true
5+
---
6+
7+
# Quality Standards
8+
9+
## Content quality guidelines
10+
11+
When creating or editing content, ensure:
12+
13+
- [ ] Content follows Microsoft style guide (sentence case headings, proper emphasis)
14+
- [ ] Front matter includes proper title, description, and metadata
15+
- [ ] Code examples are complete and include proper syntax highlighting
16+
- [ ] All links use descriptive text (avoid "click here")
17+
- [ ] Images include meaningful alt text
18+
- [ ] Content uses inclusive language and active voice
19+
- [ ] Headings follow proper hierarchy (H1 → H2 → H3)
20+
- [ ] Content is clear, concise, and action-oriented

0 commit comments

Comments
 (0)