Skip to content

Commit d2648e4

Browse files
committed
trim cursorrules
1 parent c9f0b89 commit d2648e4

File tree

1 file changed

+11
-62
lines changed

1 file changed

+11
-62
lines changed

.cursorrules

Lines changed: 11 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This is the Apify documentation repository containing platform documentation, ac
3535
- Use **sentence case** for headings (except main titles)
3636
- Use **title case** for UI elements and proper nouns
3737
- **Bold** for UI elements, buttons, menu items
38-
- *Italics* for emphasis and new terms
38+
- _Italics_ for emphasis and new terms
3939
- `code` for inline code, file names, and technical terms
4040
- Use **numbered lists** for sequential steps
4141
- Use **bullet points** for non-sequential items
@@ -93,13 +93,6 @@ Critical information that could cause issues.
9393
- Add **comments** to explain complex code
9494
- Use **syntax highlighting** for all code blocks
9595

96-
### Screenshots & images
97-
98-
- Use **light theme** for screenshots
99-
- Include **meaningful alt text**
100-
- Use **red indicators** to highlight important areas
101-
- Keep images **optimized** for web
102-
10396
## File organization
10497

10598
### Naming conventions
@@ -140,44 +133,18 @@ sources/
140133

141134
## Quality standards
142135

143-
### Content review checklist
144-
145-
- [ ] Content follows Microsoft style guide
146-
- [ ] All links are working and accurate
147-
- [ ] Code examples are tested and functional
148-
- [ ] Screenshots are up-to-date and clear
149-
- [ ] Front matter includes proper metadata
150-
- [ ] Content is accessible and inclusive
151-
152-
### Technical accuracy
153-
154-
- Verify all **technical information** is current
155-
- Test **code examples** before publishing
156-
- Ensure **screenshots** match current UI
157-
- Validate **API endpoints** and responses
158-
159-
## Development workflow
160-
161-
### Local development
136+
### Content quality guidelines
162137

163-
1. Run `npm install` to install dependencies
164-
2. Use `npm start` for basic development
165-
3. Use `npm start:dev` for full documentation set
166-
4. Run `npm run lint:md` to check markdown
167-
5. Run `npm run lint:code` to check code
138+
When creating or editing content, ensure:
168139

169-
### Linting & quality
170-
171-
- **Markdown linting**: `npm run lint:md`
172-
- **Code linting**: `npm run lint:code`
173-
- **Prose linting**: Uses Vale with Microsoft style guide
174-
- **Auto-fix**: `npm run lint:fix`
175-
176-
### Commit guidelines
177-
178-
- Follow **Conventional Commits** format
179-
- Include **comprehensive documentation updates**
180-
- Ensure all **CI checks pass**
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
181148

182149
## Common patterns
183150

@@ -189,15 +156,6 @@ sources/
189156
4. **Code examples** - Complete, working examples
190157
5. **Summary** - What they accomplished and next steps
191158

192-
### API documentation structure
193-
194-
1. **Overview** - What the endpoint does
195-
2. **Authentication** - How to authenticate
196-
3. **Parameters** - Detailed parameter descriptions
197-
4. **Request examples** - Multiple language examples
198-
5. **Response examples** - Success and error responses
199-
6. **Rate limits** - Any applicable limits
200-
201159
### Troubleshooting sections
202160

203161
- **Common issues** and solutions
@@ -210,7 +168,6 @@ sources/
210168
- Use **descriptive link text** (avoid "click here")
211169
- Include **alt text** for all images
212170
- Use **proper heading hierarchy** (H1 → H2 → H3)
213-
- Ensure **sufficient color contrast**
214171
- Write **clear, concise content**
215172

216173
## SEO best practices
@@ -221,12 +178,4 @@ sources/
221178
- Use **proper heading structure**
222179
- Include **internal links** to related content
223180

224-
## Review process
225-
226-
1. **Self-review** using the quality checklist
227-
2. **Technical review** by subject matter experts
228-
3. **Editorial review** for style and clarity
229-
4. **Accessibility review** for inclusive content
230-
5. **Final review** before publication
231-
232181
Remember: The goal is to help users succeed with Apify. Every piece of documentation should serve that purpose by being clear, accurate, and actionable.

0 commit comments

Comments
 (0)