Home - VidAIze/cursor-project-rules GitHub Wiki
Cursor Project Rules Wiki
Welcome to the Cursor Project Rules Wiki! This wiki serves as a comprehensive guide to understanding, using, and contributing to the Cursor Project Rules repository.
What is Cursor Project Rules?
Cursor Project Rules is a collection of local documentation for Cursor AI to help in building applications with modern frameworks and libraries. It provides accurate, comprehensive, and immediately accessible information, eliminating the need for web-scraped documentation that might be outdated or incomplete.
Why Use Cursor Project Rules?
- Performance: No need to wait for web scraping or API calls
- Accuracy: Carefully curated information without HTML parsing errors
- Completeness: Full documentation coverage without token limitations
- Reliability: Works even without internet connection
Getting Started
- Installation Guide - Learn how to set up Cursor Project Rules in your project
- Usage Examples - See practical examples of using the rules
- Rule Formats - Understand the structure of rule files
Documentation
The repository includes documentation for:
- AI SDK - Comprehensive guide for using the Vercel AI SDK
- OpenAI - Documentation for the OpenAI API integration
- Google Generative AI - Guide for Google's Generative AI models and API
- Clerk - Authentication and user management
- Schematic - Payment API integration
- Shadcn/UI - Component installation and usage
- TailwindCSS v4 - Latest Tailwind CSS implementation
- Convex - Complete guide for Convex database and backend services
- Polar - Documentation for Polar payment integration and implementation
Developer Resources
- Contributing Guidelines - How to contribute to the project
- Creating New Rules - Guidelines for adding new documentation rules
- Best Practices - Recommended practices for rule creation
- Troubleshooting - Common issues and their solutions
Community
- Code of Conduct - Our community standards
- Discussion Forum - Join the conversation
- Report an Issue - Help us improve
- Contributors - Meet the people who made this possible
This wiki is maintained by the community. Have a suggestion? Feel free to contribute!