hvac-kia-content/update_docs_to_hkia.py
Ben Reed 7e5377e7b1 docs: Update all documentation to use hkia naming convention
Documentation Updates:
- Updated project specification with hkia naming and paths
- Modified all markdown documentation files (12 files updated)
- Changed service names from hvac-content-* to hkia-content-*
- Updated NAS paths from /mnt/nas/hvacknowitall to /mnt/nas/hkia
- Replaced all instances of "HVAC Know It All" with "HKIA"

Files Updated:
- README.md - Updated service names and commands
- CLAUDE.md - Updated environment variables and paths
- DEPLOY.md - Updated deployment instructions
- docs/project_specification.md - Updated naming convention specs
- docs/status.md - Updated project status with new naming
- docs/final_status.md - Updated completion status
- docs/deployment_strategy.md - Updated deployment paths
- docs/DEPLOYMENT_CHECKLIST.md - Updated checklist items
- docs/PRODUCTION_TODO.md - Updated production tasks
- BACKLOG_STATUS.md - Updated backlog references
- UPDATED_CAPTURE_STATUS.md - Updated capture status
- FINAL_TALLY_REPORT.md - Updated tally report

Notes:
- Repository name remains hvacknowitall-content (unchanged)
- Project directory remains hvac-kia-content (unchanged)
- All user-facing outputs now use clean "hkia" naming

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-19 13:40:27 -03:00

113 lines
No EOL
3.6 KiB
Python
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#!/usr/bin/env python3
"""
Update all documentation files to use hkia naming convention.
"""
import re
from pathlib import Path
import logging
logging.basicConfig(level=logging.INFO, format='%(message)s')
logger = logging.getLogger(__name__)
def update_doc_file(file_path: Path) -> bool:
"""Update documentation file to use hkia naming."""
try:
with open(file_path, 'r', encoding='utf-8') as f:
content = f.read()
original_content = content
# Replace various forms of the old naming
patterns = [
# Basic replacements
(r'hvacknowitall', 'hkia'),
(r'hvacnkowitall', 'hkia'),
(r'HVACKNOWITALL', 'HKIA'),
(r'HVACNKOWITALL', 'HKIA'),
# Full name replacements
(r'HVAC Know It All', 'HKIA'),
(r'HVAC KNOW IT ALL', 'HKIA'),
(r'HvacKnowItAll', 'HKIA'),
# Path replacements
(r'/mnt/nas/hvacknowitall', '/mnt/nas/hkia'),
(r'hvac-kia-content', 'hvac-kia-content'), # Keep repo name as is
# Service name replacements
(r'hvac-content-', 'hkia-content-'),
(r'hvac-scraper', 'hkia-scraper'),
# Keep these unchanged (repo/project names)
(r'github\.com/bengizmo/hkia-content', 'github.com/bengizmo/hvacknowitall-content'),
(r'hvac-kia-content', 'hvac-kia-content'), # project directory
]
for pattern, replacement in patterns:
content = re.sub(pattern, replacement, content, flags=re.IGNORECASE if not pattern.startswith('/') else 0)
# Fix any double replacements
content = content.replace('hkia-kia', 'hvac-kia')
if content != original_content:
with open(file_path, 'w', encoding='utf-8') as f:
f.write(content)
logger.info(f"✅ Updated: {file_path.name}")
return True
else:
logger.info(f" No changes needed: {file_path.name}")
return False
except Exception as e:
logger.error(f"❌ Error updating {file_path}: {e}")
return False
def main():
"""Main update process for documentation."""
logger.info("=" * 60)
logger.info("UPDATING DOCUMENTATION TO HKIA NAMING")
logger.info("=" * 60)
base_dir = Path('/home/ben/dev/hvac-kia-content')
# Documentation files to update
doc_files = [
'README.md',
'CLAUDE.md',
'DEPLOY.md',
'docs/project_specification.md',
'docs/image_downloads.md',
'docs/status.md',
'docs/final_status.md',
'docs/deployment_strategy.md',
'docs/DEPLOYMENT_CHECKLIST.md',
'docs/PRODUCTION_TODO.md',
'BACKLOG_STATUS.md',
'UPDATED_CAPTURE_STATUS.md',
'FINAL_TALLY_REPORT.md',
]
# Update documentation files
logger.info("\n📝 Updating documentation files...")
updated_count = 0
for file_path in doc_files:
full_path = base_dir / file_path
if full_path.exists():
if update_doc_file(full_path):
updated_count += 1
else:
logger.info(f"⚠️ File not found: {file_path}")
# Summary
logger.info("\n" + "=" * 60)
logger.info("DOCUMENTATION UPDATE COMPLETE")
logger.info("=" * 60)
logger.info(f"Files updated: {updated_count}")
logger.info("\nNext steps:")
logger.info("1. Review changes with 'git diff'")
logger.info("2. Commit documentation updates")
logger.info("3. Push to repository")
if __name__ == "__main__":
main()