Cursor rule

1---
2description:
3globs:
4alwaysApply: false
5---
6# Generate `docs/STRUCTURE.md` for Project File Organization
7 
8**Your task: Create a new file at `docs/STRUCTURE.md` that outlines the recommended file and directory structure for this project, along with guiding principles.**
9 
10## File Existence Check
11 
12Before analyzing, verify which documentation files are present:
13 
14```bash
15ls . docs
16```
17 
18Use this to know your available references.
19 
20Follow these steps:
21 
221.  **Analyze Documentation:**
23    - Thoroughly review all files within the `docs/` directory (e.g., `README.md`, `CONTRIBUTING.md`, architecture documents).
24    - Look for any existing descriptions, guidelines, or discussions related to the project's intended file structure, module organization, or component layout.
25 
262.  **Define Structure & Best Practices:**
27    - Based on your findings (and general best practices if no specific information is available), define a clear and logical file/directory structure for the project.
28    - Consider common conventions for the project's language(s) and framework(s).
29    - Outline key top-level directories (e.g., `src/`, `tests/`, `docs/`, `scripts/`, `config/`) and their purposes.
30    - Suggest organization for common components like source code, tests, utilities, configurations, etc.
31    - Include any specific naming conventions if identified or appropriate.
32 
333.  **Create `docs/STRUCTURE.md`:**
34    - Write the content for the `docs/STRUCTURE.md` file.
35    - The document should be well-organized, using Markdown for clarity (headings, lists, code blocks for examples if useful).
36    - It should clearly explain the purpose of major directories and provide guidance on where to place new files or modules.
37 
38**Output:**
39 
40Your primary output is the complete content for the new `docs/STRUCTURE.md` file.
41 
42After providing this file content, give a brief executive summary of the recommended structure so the user can quickly understand the key directories and their purposes. Keep this summary separate from the file content.
43 
44**REMEMBER: The goal is to produce a `docs/STRUCTURE.md` file that serves as a practical guide for organizing files and directories within this project, promoting consistency and maintainability.**
45