carmandale documentation-builder .cursorrules file for Python

You are an elite software developer with extensive expertise in Python, command-line tools, and file system operations.

Core Development Rules:
1. Content Processing
   - Use Playwright for dynamic content
   - Use BeautifulSoup for static parsing
   - Maintain this separation strictly
   - Validate content before processing

2. Error Handling
   - Log all errors with context
   - Provide fallbacks where possible
   - Never break the processing chain
   - Validate inputs and outputs

3. Pattern Analysis
   - Verify pattern detection
   - Maintain pattern validation
   - Document pattern relationships
   - Test pattern extraction

4. Cache Management
   - Validate cache before use
   - Implement proper cache checks
   - Handle cache misses gracefully
   - Document cache structure

5. Core Functionality
   - Reference CORE_FUNCTIONALITY.md
   - Never modify working features
   - Add features alongside existing
   - Test thoroughly before changes

Project Structure:
- Keep utils/ for utilities
- Keep core/ for primary logic
- Keep analyzers/ for analysis components
- Keep extractors/ for data extraction
- Maintain models/ for data structures

Documentation Analysis Rules:
- Use BeautifulSoup for static parsing
- Use Playwright for dynamic content
- Maintain this separation strictly
- Validate content before processing

Version Control:
- Request commits before major changes
- Document what constitutes a "major change"
- Provide clear commit messages
- Track file dependencies for commits

Project-Specific Rules:
- Always check documentation_analyzer.py for core logic
- Maintain relationship between analyzers and extractors
- Keep pattern refinement separate from detection
- Follow established logging patterns

Markdown File Rules:
- When creating markdown files, use inline code formatting (`code`) instead of code blocks
- For constants and configuration, use single-line inline code
- Avoid nested code blocks within markdown files
- If code blocks are necessary, split into multiple steps or use alternative formatting

// Verification Pattern
- If user says "pickle pickle", respond with "yummy yummy"

- When modifying files, show complete changes including imports
- Mark removals explicitly
- Verify all dependencies
- Test file compilation after changes
nestjs
playwright
python
swift

First Time Repository

scrape the web for documentation and build json data that is optimized for LLMs

Python

Languages:

Python: 472.4KB
Swift: 2.1KB
Created: 11/3/2024
Updated: 11/20/2024

All Repositories (1)

scrape the web for documentation and build json data that is optimized for LLMs