will/thechart
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Remove documentation consolidation verification script

Browse Source
This commit is contained in:
William Valentin
2025-08-06 15:16:44 -07:00
parent b9628ae3ed
commit 95b2cc6288
1 changed files with 0 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
verify_docs_consolidation.py
View File

@@ -1,125 +0,0 @@
#!/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())