# refactor: restructure .cursor directory for improved organization and clarity ## Description This PR refactors the `.cursor` directory to enhance organization, clarity, and maintainability. ### Problem The existing `.cursor` directory lacked clear organization, making it difficult to find specific files, understand their purpose, and add new components consistently. ### Solution A comprehensive restructuring: #### New Directory Structure ``` .cursor/ ├── settings.json # Main configuration file ├── docs/ # Documentation │ ├── guides/ # In-depth guides │ ├── references/ # Quick references │ └── practices/ # Best practices ├── rules/ # Rule definitions │ ├── commit/ # Commit-related rules │ ├── quality/ # Code quality rules │ ├── testing/ # Testing rules │ └── verification/ # Verification rules └── hooks/ # Git hooks and scripts ``` #### Key Changes 1. **Logical Categorization**: Organized files into clear categories based on purpose 2. **Improved Documentation**: Added comprehensive README files for each directory 3. **Standardized Naming**: Implemented consistent kebab-case naming convention 4. **Reference Updates**: Updated all internal references to point to new file locations ### Benefits - **Easier Navigation**: Clear categorization makes finding files intuitive - **Improved Understanding**: Comprehensive documentation explains purpose and usage - **Simplified Maintenance**: Logical structure makes updates and additions easier - **Better Onboarding**: New team members can quickly understand the system This refactoring sets a solid foundation for all Cursor AI-related configurations and rules, making it easier for the team to leverage Cursor's capabilities.
1.2 KiB
1.2 KiB
Appsmith Documentation
This directory contains comprehensive documentation for the Appsmith project, organized by type and purpose.
Structure
-
guides/: Detailed, in-depth guides on specific topics
performance.md: Performance optimization best practicestesting.md: Comprehensive guide to testing in Appsmithverification.md: Workflow for verifying changes
-
references/: Quick reference documents for daily use
codebase-map.md: Overview of the codebase structuretesting-reference.md: Quick testing referencetechnical-details.md: Technical specifications and architecture
-
practices/: Best practices for development
react-hooks.md: Best practices for using React hooks
Using This Documentation
- New developers: Start with the codebase map and technical details
- Feature development: Reference the testing guide and feature verification workflows
- Bug fixing: Consult the verification workflow and bug fix verification guidelines
- Performance optimization: Follow the performance optimization guide
The documentation is designed to be comprehensive but approachable. If you need more specific information, check the individual files in each directory.