Cursor rule

1---
2description: when making code changes or adding documentation
3globs: ["*.py", "*.md"]
4alwaysApply: true
5---
6 
7- When making code changes:
8    - Update related documentation files to reflect the changes
9    - Check docstrings and type hints are up to date
10    - Update any example code in markdown files
11    - Review README.md if the changes affect installation or usage
12 
13- When creating new markdown files:
14    - Add the file to mkdocs.yml under the appropriate section
15    - Follow the existing hierarchy and indentation
16    - Use descriptive nav titles
17    - Example:
18```yaml
19        nav:
20          - Home: index.md
21          - Guides:
22              - Getting Started: guides/getting-started.md
23              - Your New File: guides/your-new-file.md
24```
25 
26- For API documentation:
27    - Ensure new functions/classes are documented
28    - Include type hints and docstrings
29    - Add usage examples
30    - Update API reference docs if auto-generated
31 
32- Documentation Quality:
33    - Write at grade 10 reading level (see simple-language.mdc)
34    - Include working code examples
35    - Add links to related documentation
36    - Use consistent formatting and style