Add CI/CD pipeline documentation and implement validation scripts for documentation structure and problem directories

Author: ayanalamMOON

.github/README.md

@@ -0,0 +1,207 @@
+# 🚀 CI/CD Pipeline Documentation
+
+This directory contains the automated CI/CD pipeline for the LeetCode Problem Solutions repository. The pipeline automatically updates all documentation files when new problems are added.
+
+## 📁 Structure
+
+```
+.github/
+├── workflows/
+│   ├── auto-update-docs.yml    # Main auto-update workflow
+│   ├── validate-docs.yml       # Documentation validation
+│   └── manual-update.yml       # Manual update trigger
+└── scripts/
+    ├── update_documentation.py # Main documentation updater
+    ├── validate_documentation.py # Documentation validator
+    ├── check_links.py          # Link checker
+    ├── validate_problems.py    # Problem structure validator
+    └── manual_update.py        # Manual update script
+```
+
+## 🔄 Workflows
+
+### 1. Auto-Update Documentation (`auto-update-docs.yml`)
+
+**Triggers:**
+- Push to `main`/`master` branch with changes in problem directories
+- Pull requests affecting problem directories
+
+**Actions:**
+- Detects new/modified problems
+- Scans problem metadata (title, difficulty, topics, languages)
+- Updates all documentation files:
+  - `README.md` - Repository structure and problem tables
+  - `INDEX.md` - Problem indices and categorization
+  - `PERFORMANCE_ANALYSIS.md` - Performance metrics and analysis
+  - `InterviewPreparation.md` - Interview references and examples
+- Commits changes automatically
+
+### 2. Documentation Validation (`validate-docs.yml`)
+
+**Triggers:**
+- All pushes and pull requests
+
+**Actions:**
+- Validates documentation structure
+- Checks for broken internal links
+- Validates problem directory structure
+- Ensures markdown syntax correctness
+
+### 3. Manual Update (`manual-update.yml`)
+
+**Triggers:**
+- Manual workflow dispatch
+
+**Options:**
+- Update type: `all`, `readme`, `index`, `performance`, `interview-prep`
+- Force update: Update even if no changes detected
+
+## 🛠️ Scripts
+
+### `update_documentation.py`
+Main documentation updater that:
+- Scans all problem directories
+- Extracts metadata from `Problem.md` files
+- Detects available solution languages
+- Updates all documentation files with new content
+
+### `validate_documentation.py`
+Validates documentation structure:
+- Checks for required sections
+- Validates markdown format
+- Ensures consistency across files
+
+### `check_links.py`
+Validates internal links:
+- Finds broken relative links
+- Skips external URLs
+- Reports missing referenced files
+
+### `validate_problems.py`
+Validates problem directory structure:
+- Ensures `Problem.md` exists
+- Checks for solution files
+- Validates problem metadata format
+
+## 🚀 How It Works
+
+### Automatic Updates
+
+1. **Detection**: When you push changes to problem directories, the workflow detects modified files
+2. **Scanning**: The script scans all problem directories and extracts metadata
+3. **Update**: All documentation files are updated with new problem information
+4. **Commit**: Changes are automatically committed with a descriptive message
+
+### Adding New Problems
+
+When you add a new problem:
+
+1. Create the problem directory (e.g., `Daily_Problems/DailyProblem7/`)
+2. Add `Problem.md` with proper format:
+   ```markdown
+   # 1234. Problem Title
+   
+   **Difficulty**: Medium
+   **Topics**: Array, Dynamic Programming
+   
+   [Problem description...]
+   ```
+3. Add solution files (`InCPP.cpp`, `InJava.java`, etc.)
+4. Push to repository
+5. CI/CD automatically updates all documentation! 🎉
+
+### Manual Updates
+
+If you need to manually trigger updates:
+
+1. Go to GitHub Actions tab
+2. Select "Manual Documentation Update"
+3. Click "Run workflow"
+4. Choose update type and options
+5. Click "Run workflow" button
+
+## 📊 Monitoring
+
+### GitHub Actions Dashboard
+- View workflow runs and status
+- Check validation results
+- Monitor automatic updates
+
+### Workflow Summaries
+Each workflow provides detailed summaries:
+- Files changed
+- Problems detected
+- Validation results
+- Performance reports
+
+## 🔧 Configuration
+
+### Environment Variables
+- `GITHUB_TOKEN`: Automatically provided by GitHub Actions
+- No additional secrets required
+
+### Permissions
+Workflows have:
+- `contents: write` - To commit documentation updates
+- `pull-requests: write` - To comment on PRs
+
+## 🛡️ Error Handling
+
+### Validation Failures
+- Broken links stop the workflow
+- Missing required files generate warnings
+- Structure violations are reported
+
+### Update Failures
+- Failed updates are logged
+- Manual intervention may be required
+- Rollback procedures available
+
+## 🎯 Best Practices
+
+### Problem Structure
+Ensure each problem directory has:
+- `Problem.md` with proper format
+- At least one solution file
+- Consistent naming conventions
+
+### Commit Messages
+Automatic commits include:
+- Changed files list
+- Problem numbers affected
+- Timestamp and workflow info
+
+### Review Process
+- Validate changes before pushing
+- Review auto-generated documentation
+- Monitor workflow results
+
+## 🚀 Benefits
+
+### Automation
+- ✅ Zero manual documentation maintenance
+- ✅ Consistent formatting across all files
+- ✅ Real-time updates when problems are added
+
+### Quality Assurance
+- ✅ Link validation prevents broken references
+- ✅ Structure validation ensures consistency
+- ✅ Automatic error detection and reporting
+
+### Developer Experience
+- ✅ Focus on problem-solving, not documentation
+- ✅ Immediate feedback on changes
+- ✅ Professional-quality repository maintenance
+
+## 🔮 Future Enhancements
+
+Planned improvements:
+- Performance benchmark automation
+- Test case validation
+- Solution correctness checking
+- Multi-language compilation testing
+- Advanced metrics and analytics
+
+---
+
+**Happy Coding!** 🎉 The CI/CD pipeline ensures your repository stays perfectly organized and up-to-date automatically!

.github/scripts/check_links.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python3
+"""
+Link Checker for Documentation
+==============================
+
+Checks for broken internal links in all markdown files.
+"""
+
+import os
+import re
+from pathlib import Path
+import logging
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+class LinkChecker:
+    def __init__(self):
+        self.root_path = Path(".")
+        self.broken_links = []
+    
+    def check_file_links(self, file_path: Path) -> None:
+        """Check all links in a markdown file"""
+        if not file_path.exists():
+            return
+        
+        content = file_path.read_text(encoding='utf-8')
+        
+        # Find all markdown links [text](url)
+        link_pattern = r'\[([^\]]+)\]\(([^)]+)\)'
+        links = re.findall(link_pattern, content)
+        
+        for link_text, link_url in links:
+            # Skip external links (http/https)
+            if link_url.startswith(('http://', 'https://', 'mailto:')):
+                continue
+            
+            # Skip anchors
+            if link_url.startswith('#'):
+                continue
+            
+            # Check if file exists
+            target_path = file_path.parent / link_url
+            if not target_path.exists():
+                # Try relative to root
+                target_path = self.root_path / link_url
+                if not target_path.exists():
+                    self.broken_links.append({
+                        'file': str(file_path),
+                        'link_text': link_text,
+                        'link_url': link_url
+                    })
+    
+    def run(self) -> int:
+        """Check all markdown files for broken links"""
+        logger.info("Starting link validation...")
+        
+        # Check all markdown files
+        md_files = list(self.root_path.glob("*.md"))
+        md_files.extend(self.root_path.glob("**/*.md"))
+        
+        for md_file in md_files:
+            # Skip files in .git directory
+            if '.git' in str(md_file):
+                continue
+            self.check_file_links(md_file)
+        
+        # Report results
+        if self.broken_links:
+            logger.error(f"Found {len(self.broken_links)} broken links:")
+            for link in self.broken_links:
+                logger.error(f"  ❌ {link['file']}: [{link['link_text']}]({link['link_url']})")
+        else:
+            logger.info("✅ All links are valid!")
+        
+        return len(self.broken_links)
+
+if __name__ == "__main__":
+    checker = LinkChecker()
+    exit_code = checker.run()
+    exit(exit_code)

.github/scripts/manual_update.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+"""
+Manual Documentation Update Script
+=================================
+
+Allows manual triggering of documentation updates with specific options.
+"""
+
+import argparse
+import sys
+from pathlib import Path
+
+# Import the main updater
+sys.path.append(str(Path(__file__).parent))
+from update_documentation import DocumentationUpdater
+
+class ManualUpdater(DocumentationUpdater):
+    def __init__(self, update_type: str, force: bool):
+        super().__init__()
+        self.update_type = update_type
+        self.force = force
+    
+    def run(self) -> None:
+        """Run manual update based on specified type"""
+        print(f"Starting manual documentation update (type: {self.update_type}, force: {self.force})")
+        
+        self.scan_problems()
+        
+        if not self.force and not self.daily_problems and not self.regular_problems:
+            print("No problems found and force=False, skipping update")
+            return
+        
+        if self.update_type in ['all', 'readme']:
+            print("Updating README.md...")
+            self.update_readme()
+        
+        if self.update_type in ['all', 'index']:
+            print("Updating INDEX.md...")
+            self.update_index()
+        
+        if self.update_type in ['all', 'performance']:
+            print("Updating PERFORMANCE_ANALYSIS.md...")
+            self.update_performance_analysis()
+        
+        if self.update_type in ['all', 'interview-prep']:
+            print("Updating InterviewPreparation.md...")
+            self.update_interview_preparation()
+        
+        print("Manual documentation update completed!")
+
+def main():
+    parser = argparse.ArgumentParser(description='Manual documentation updater')
+    parser.add_argument('--type', choices=['all', 'readme', 'index', 'performance', 'interview-prep'], 
+                       default='all', help='Type of update to perform')
+    parser.add_argument('--force', type=bool, default=False, 
+                       help='Force update even if no changes detected')
+    
+    args = parser.parse_args()
+    
+    updater = ManualUpdater(args.type, args.force)
+    updater.run()
+
+if __name__ == "__main__":
+    main()