From 652ef3e49385794208118664f80a13490feffd4b Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 30 Jun 2025 13:48:46 -0700 Subject: [PATCH 1/6] update cursor rule --- .cursor/rules/writing-standards.mdc | 30 +++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/.cursor/rules/writing-standards.mdc b/.cursor/rules/writing-standards.mdc index 1b2cfd7e2..06720a90e 100644 --- a/.cursor/rules/writing-standards.mdc +++ b/.cursor/rules/writing-standards.mdc @@ -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 @@ -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 \ No newline at end of file +- 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 when: Sequential numbered instructions +- Use when: Platform-specific alternatives +- Use when: Optional supplementary info + +### For code examples: +- Use single ``` when: One language, simple example +- Use when: Same concept in multiple languages +- Use / when: API documentation \ No newline at end of file From a46f79cc492205c010b535719d36e683c4c67908 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 30 Jun 2025 16:17:19 -0700 Subject: [PATCH 2/6] update cursor rule --- guides/cursor.mdx | 97 +++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 45 deletions(-) diff --git a/guides/cursor.mdx b/guides/cursor.mdx index 6a398adfd..fcc449f56 100644 --- a/guides/cursor.mdx +++ b/guides/cursor.mdx @@ -30,7 +30,7 @@ You can use this example as-is or customize it for your documentation: Add this rule with any modifications as an `.mdc` file in your `.cursor/rules` directory. -```` +````md --- description: Mintlify writing assistant guidelines type: always @@ -46,6 +46,7 @@ You are an AI writing assistant specialized in creating exceptional technical do - Write in second person ("you") for instructions and procedures - Use active voice over passive voice - Employ present tense for current states, future tense for outcomes +- Avoid jargon unless necessary and define terms when first used - Maintain consistent terminology throughout all documentation - Keep sentences concise while providing necessary context - Use parallel structure in lists, headings, and procedures @@ -56,14 +57,15 @@ You are an AI writing assistant specialized in creating exceptional technical do - Break complex procedures into numbered steps - Include prerequisites and context before instructions - Provide expected outcomes for each major step -- End sections with next steps or related information - Use descriptive, keyword-rich headings for navigation and SEO +- Group related information logically with clear section breaks ### User-centered approach - Focus on user goals and outcomes rather than system features - Anticipate common questions and address them proactively - Include troubleshooting for likely failure points -- Provide multiple pathways when appropriate (beginner vs advanced), but offer an opinionated path for people to follow to avoid overwhelming with options +- Write for scannability with clear headings, lists, and white specialized +- Include verification steps to confirm success ## Mintlify component reference @@ -225,6 +227,22 @@ curl -X POST 'https://api.example.com/users' \ +### Cards and columns for emphasizing information + + +Complete walkthrough from installation to your first API call in under 10 minutes. + + + + + Learn how to authenticate requests using API keys or JWT tokens. + + + + Understand rate limits and best practices for high-volume usage. + + + ### API documentation components #### Parameter fields @@ -281,24 +299,6 @@ Complete user object with all associated data. -### Interactive components - -#### Cards for navigation - - -Complete walkthrough from installation to your first API call in under 10 minutes. - - - - - Learn how to authenticate requests using API keys or JWT tokens. - - - - Understand rate limits and best practices for high-volume usage. - - - ### Media and advanced components #### Frames for images @@ -313,12 +313,37 @@ Wrap all images in frames. Analytics dashboard with charts -#### Tooltips and updates +#### Videos + +Use the HTML `