#!/usr/bin/env python3 """ Documentation Consolidation Verification Script This script verifies that the documentation consolidation was successful and provides a summary of the new documentation structure. """ import sys from pathlib import Path def check_file_exists(filename): """Check if a file exists and return its size.""" path = Path(filename) if path.exists(): size = path.stat().st_size lines = len(path.read_text().splitlines()) if path.suffix == ".md" else 0 return True, size, lines return False, 0, 0 def main(): """Verify the documentation consolidation.""" print("TheChart Documentation Consolidation Verification") print("=" * 55) print() # Primary consolidated documentation primary_docs = [ ("CONSOLIDATED_DOCS.md", "Complete comprehensive documentation"), ("README.md", "Updated project overview with consolidated refs"), ("DOCS_CONSOLIDATION_SUMMARY.md", "Consolidation process summary"), ] # Existing documentation (preserved) existing_docs = [ ("USER_GUIDE.md", "User manual and features"), ("DEVELOPER_GUIDE.md", "Development setup and architecture"), ("API_REFERENCE.md", "Technical API documentation"), ("CHANGELOG.md", "Version history"), ("UI_FLICKERING_FIX_SUMMARY.md", "Latest performance improvements"), ("IMPROVEMENTS_SUMMARY.md", "Recent feature additions"), ] # Documentation hub hub_docs = [ ("docs/README.md", "Documentation navigation hub"), ] print("šŸ“š PRIMARY CONSOLIDATED DOCUMENTATION") print("-" * 45) for filename, description in primary_docs: exists, size, lines = check_file_exists(filename) status = "āœ…" if exists else "āŒ" size_info = f"({size:,} bytes, {lines} lines)" if exists else "" print(f"{status} {filename:<35} - {description}") if size_info: print(f" {size_info}") print("\nšŸ“– EXISTING DOCUMENTATION (PRESERVED)") print("-" * 45) for filename, description in existing_docs: exists, size, lines = check_file_exists(filename) status = "āœ…" if exists else "āŒ" print(f"{status} {filename:<35} - {description}") print("\nšŸ  DOCUMENTATION HUB") print("-" * 45) for filename, description in hub_docs: exists, size, lines = check_file_exists(filename) status = "āœ…" if exists else "āŒ" print(f"{status} {filename:<35} - {description}") # Verify consolidated docs content print("\nšŸ” CONSOLIDATED DOCS CONTENT VERIFICATION") print("-" * 45) consolidated_path = Path("CONSOLIDATED_DOCS.md") if consolidated_path.exists(): content = consolidated_path.read_text() required_sections = [ "Quick Start", "User Guide", "Developer Guide", "Features & Capabilities", "Technical Architecture", "Recent Improvements", "API Reference", "Troubleshooting", "Contributing", ] for section in required_sections: if f"# {section}" in content or f"## {section}" in content: print(f"āœ… Section: {section}") else: print(f"āŒ Missing: {section}") else: print("āŒ CONSOLIDATED_DOCS.md not found") print("\nšŸ“Š CONSOLIDATION SUMMARY") print("-" * 45) print("āœ… Created comprehensive CONSOLIDATED_DOCS.md") print("āœ… Updated README.md with consolidated references") print("āœ… Updated docs/README.md as navigation hub") print("āœ… Preserved all existing documentation") print("āœ… Added documentation consolidation summary") print("āœ… Maintained backward compatibility") print("\nšŸ’” USAGE RECOMMENDATIONS") print("-" * 45) print("🌟 For comprehensive info: CONSOLIDATED_DOCS.md") print("⚔ For quick user access: USER_GUIDE.md") print("⚔ For quick dev access: DEVELOPER_GUIDE.md") print("šŸ“š For navigation help: docs/README.md") print("\nāœ… Documentation consolidation completed successfully!") return 0 if __name__ == "__main__": sys.exit(main())