Skip to content

Commit ac7aa76

Browse files
authored
Update Cursor rule example (#885)
* update cursor rule * update cursor rule * formatting * formatting * update intro to rule example * fix casing
1 parent 614e25f commit ac7aa76

File tree

2 files changed

+170
-112
lines changed

2 files changed

+170
-112
lines changed

.cursor/rules/writing-standards.mdc

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ description: "Concise description explaining page purpose and value"
428428
- Verify all code examples are syntactically correct and executable
429429
- Test all links to ensure they are functional and lead to relevant content
430430
- Validate Mintlify component syntax with all required properties
431-
- Confirm proper heading hierarchy with H2 for main sections, H3 for subsections
431+
- Confirm proper heading hierarchy with H2 for main sections, H3 for subsections. Do not use H1 (reserved for page title)
432432
- Ensure content flows logically from basic concepts to advanced topics
433433
- Check for consistency in terminology, formatting, and component usage
434434
- Include appropriate warnings for destructive or security-sensitive actions
@@ -483,4 +483,30 @@ description: "Concise description explaining page purpose and value"
483483
- Regularly review and update outdated information
484484
- Remove deprecated features and references
485485
- Update screenshots when UI changes occur
486-
- Maintain consistency across related documentation pages
486+
- Maintain consistency across related documentation pages
487+
488+
## Request handling examples
489+
490+
### When asked to "create a new page":
491+
1. First, determine the appropriate location in the file structure
492+
2. Create the file with proper frontmatter
493+
3. Structure content using appropriate Mintlify components
494+
4. Include relevant images and code examples
495+
496+
### When asked to "improve existing content":
497+
1. Review current structure and identify gaps
498+
2. Suggest specific component improvements
499+
3. Add missing callouts or examples
500+
4. Ensure proper heading hierarchy
501+
502+
## Component selection decision trees
503+
504+
### For procedures:
505+
- Use <Steps> when: Sequential numbered instructions
506+
- Use <Tabs> when: Platform-specific alternatives
507+
- Use <AccordionGroup> when: Optional supplementary info
508+
509+
### For code examples:
510+
- Use single ``` when: One language, simple example
511+
- Use <CodeGroup> when: Same concept in multiple languages
512+
- Use <RequestExample>/<ResponseExample> when: API documentation

0 commit comments

Comments
 (0)