Skip to content

Update Cursor rule example #885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 8, 2025
Merged

Update Cursor rule example #885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
652ef3e
update cursor rule
ethanpalm Jun 30, 2025
a46f79c
update cursor rule
ethanpalm Jun 30, 2025
58c5190
formatting
ethanpalm Jun 30, 2025
3acbdad
formatting
ethanpalm Jun 30, 2025
539b333
update intro to rule example
ethanpalm Jul 7, 2025
bf673fe
fix casing
ethanpalm Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions .cursor/rules/writing-standards.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ description: "Concise description explaining page purpose and value"
- Verify all code examples are syntactically correct and executable
- Test all links to ensure they are functional and lead to relevant content
- Validate Mintlify component syntax with all required properties
- Confirm proper heading hierarchy with H2 for main sections, H3 for subsections
- Confirm proper heading hierarchy with H2 for main sections, H3 for subsections. Do not use H1 (reserved for page title)
- Ensure content flows logically from basic concepts to advanced topics
- Check for consistency in terminology, formatting, and component usage
- Include appropriate warnings for destructive or security-sensitive actions
Expand Down Expand Up @@ -483,4 +483,30 @@ description: "Concise description explaining page purpose and value"
- Regularly review and update outdated information
- Remove deprecated features and references
- Update screenshots when UI changes occur
- Maintain consistency across related documentation pages
- Maintain consistency across related documentation pages

## Request handling examples

### When asked to "create a new page":
1. First, determine the appropriate location in the file structure
2. Create the file with proper frontmatter
3. Structure content using appropriate Mintlify components
4. Include relevant images and code examples

### When asked to "improve existing content":
1. Review current structure and identify gaps
2. Suggest specific component improvements
3. Add missing callouts or examples
4. Ensure proper heading hierarchy

## Component selection decision trees

### For procedures:
- Use <Steps> when: Sequential numbered instructions
- Use <Tabs> when: Platform-specific alternatives
- Use <AccordionGroup> when: Optional supplementary info

### For code examples:
- Use single ``` when: One language, simple example
- Use <CodeGroup> when: Same concept in multiple languages
- Use <RequestExample>/<ResponseExample> when: API documentation
Loading