AI SummaryCursor Rules for Starknet documentation that enforces Mintlify technical writing standards and best practices for creating clear, user-centered developer documentation. Ideal for Starknet contributors and documentation maintainers using Cursor.
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to add the "starknet-docs — Cursor Rules" prompt rules to my project. Repository: https://github.com/starknet-io/starknet-docs Please read the repo to find the rules/prompt file, then: 1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type) 2. If there's an existing rules file, merge the new rules in rather than overwriting 3. Confirm what was added
Description
Starknet's developer documentation
Language and style requirements
• Use clear, direct language appropriate for technical audiences • 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
New features
• Added bulk user import functionality • Improved error messages with actionable suggestions
Code examples requirements
• Always include complete, runnable examples that users can copy and execute • Show proper error handling and edge case management • Use realistic data instead of placeholder values • Include expected outputs and results for verification • Test all code examples thoroughly before publishing • Specify language and include filename when relevant • Add explanatory comments for complex logic • Never include real API keys or secrets in code examples
API documentation requirements
• Document all parameters including optional ones with clear descriptions • Show both success and error response examples with realistic data • Include rate limiting information with specific limits • Provide authentication examples showing proper format • Explain all HTTP status codes and error handling • Cover complete request/response cycles
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster
Works With
Any AI assistant that accepts custom rules or system prompts