Add docs

Author: Shashikant86

.pre-commit-config.yaml

@@ -23,6 +23,7 @@ repos:
       - id: end-of-file-fixer
       - id: check-yaml
         args: [--allow-multiple-documents]
+        exclude: ^mkdocs\.yml$
       - id: check-toml
       - id: check-json
       - id: check-added-large-files

docs/getting-started/installation.md

@@ -13,9 +13,9 @@ Before installing DSPy Code, make sure you have:
 
 !!! warning "CRITICAL: Create Virtual Environment IN Your Project"
     **For security and isolation, ALWAYS create your virtual environment INSIDE your project directory!**
-    
+
     This ensures:
-    
+
     - 🔒 All file scanning stays within your project
     - 📦 Complete project isolation
     - 🚀 Easy sharing and deployment
@@ -43,11 +43,11 @@ source .venv/bin/activate  # On macOS/Linux
 
 !!! success "Why .venv in the Project?"
     When you create the virtual environment inside your project:
-    
+
     - All packages install to `my-dspy-project/.venv/`
     - All dspy-code data goes to `my-dspy-project/.dspy_code/`
     - Everything stays in one place!
-    
+
     **Result**: One directory = one complete project
 
 ### Step 3: Install DSPy Code

docs/guide/project-management.md

@@ -53,12 +53,12 @@ my-dspy-project/
 
 !!! success "Everything in One Place"
     Notice how **everything** is inside `my-dspy-project/`:
-    
+
     - Virtual environment (`.venv/`)
     - All packages (in `.venv/lib/`)
     - All caches (`.dspy_cache/`, `.dspy_code/`)
     - All your code (`generated/`, `modules/`, etc.)
-    
+
     **Result**: Delete `my-dspy-project/` and everything is gone!
 
 **Interactive prompts:**

docs/reference/security.md

@@ -399,4 +399,3 @@ DSPy Code is designed to be **secure by default**:
 ---
 
 **Questions about security?** [Open an issue](https://github.com/SuperagenticAI/dspy-code/issues) or check our [FAQ](faq.md).
-

dspy_code/main.py

@@ -7,7 +7,6 @@
 All commands are now SLASH COMMANDS in interactive mode!
 """
 
-import os
 import sys
 from pathlib import Path
 

dspy_code/rag/indexer.py

@@ -579,7 +579,7 @@ def _is_safe_to_scan(self, path: Path) -> bool:
                 if len(parts) <= 1:
                     logger.warning(f"🚨 BLOCKED: Path too close to home directory: {path}")
                     logger.warning(
-                        f"   Please run dspy-code from a project directory, not from ~/ or ~/subdir"
+                        "   Please run dspy-code from a project directory, not from ~/ or ~/subdir"
                     )
                     return False
 

mkdocs.yml

@@ -26,11 +26,11 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
-  
+
   font:
     text: Roboto
     code: Roboto Mono
-  
+
   features:
     - navigation.instant
     - navigation.tracking
@@ -42,7 +42,7 @@ theme:
     - search.highlight
     - content.code.copy
     - content.code.annotate
-  
+
   icon:
     repo: fontawesome/brands/github
     admonition:
@@ -95,9 +95,9 @@ extra:
       link: https://github.com/superagentic-ai/dspy-code
     - icon: fontawesome/brands/python
       link: https://pypi.org/project/dspy-code/
-  
+
   generator: false
-  
+
   version:
     provider: mike
 
@@ -110,7 +110,7 @@ nav:
     - ⚡ Quick Start: getting-started/quick-start.md
     - 🎯 First Program: getting-started/first-program.md
     - 💡 Understanding DSPy Code: getting-started/understanding.md
-  
+
   - 📚 User Guide:
     - 💬 Interactive Mode: guide/interactive-mode.md
     - 🗣️ Natural Language Commands: guide/natural-language-commands.md
@@ -126,27 +126,27 @@ nav:
     - 🎯 Optimization: guide/optimization.md
     - 📁 Project Management: guide/project-management.md
     - 📊 Creating Gold Data: guide/creating-gold-data.md
-  
+
   - 🎓 Tutorials:
     - 😊 Build a Sentiment Analyzer: tutorials/sentiment-analyzer.md
     - 🔍 Create a RAG System: tutorials/rag-system.md
     - ❓ Question Answering: tutorials/question-answering.md
     - 🧬 Optimize with GEPA: tutorials/gepa-optimization.md
-  
+
   - 📖 Reference:
     - 📝 Command Reference: reference/commands.md
     - ⚙️ Configuration: reference/configuration.md
     - 🔒 Security & Best Practices: reference/security.md
     - 📋 Templates: reference/templates.md
     - 🔧 Troubleshooting: reference/troubleshooting.md
     - ❓ FAQ: reference/faq.md
-  
+
   - 🚀 Advanced:
     - 🔗 MCP Integration: advanced/mcp-integration.md
     - 🧩 Custom Modules: advanced/custom-modules.md
     - 🚢 Deployment: advanced/deployment.md
     - 🔄 CI/CD Integration: advanced/cicd.md
-  
+
   - ℹ️ About:
     - 📖 About DSPy Code: about/index.md
     - 💡 Why DSPy Code?: about/why-dspy-code.md

tests/test_security.py

@@ -4,7 +4,6 @@
 Tests for file system safety measures and security protections.
 """
 
-import os
 import tempfile
 from pathlib import Path
 from unittest.mock import patch