mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-04-29 00:59:07 -05:00
3b37726b27
Consolidated 21 root-level scripts into logical subdirectories: New structure: - images/: All image management scripts (10 files consolidated from 3 locations) - infrastructure/: CI/CD and container scripts (3 files) - content/: Added formatting scripts (3 files moved from root) - testing/: All test scripts (5 files consolidated) - glossary/: Added standardize_glossaries.py - maintenance/: Added generate_release_notes.py, preflight.py - utilities/: Added validation scripts Benefits: - Reduced root-level clutter (21 → 2 files) - Related scripts grouped logically - Easier to find and maintain scripts - Follows standard project organization patterns Changes: - Created new subdirectories: images/, infrastructure/ - Moved scripts from root to appropriate subdirectories - Consolidated scattered scripts (images were in 3 places) - Updated all pre-commit hook references - Created README files for new directories - Included backup file for rollback if needed Tool: tools/scripts/reorganize_scripts.py (for future reference)
Glossary Management Scripts
Scripts for managing the ML Systems textbook glossary system.
Quick Commands
Full Rebuild (when chapters change)
cd /Users/VJ/GitHub/MLSysBook
python3 tools/scripts/glossary/build_master_glossary.py
python3 tools/scripts/glossary/generate_glossary.py
Individual Chapter Update
# 1. Use glossary-builder agent to update specific chapter
# 2. Then rebuild:
python3 tools/scripts/glossary/build_master_glossary.py
python3 tools/scripts/glossary/generate_glossary.py
Data Flow
Chapter QMDs → Agent → Individual JSONs → build_master_glossary.py → Master JSON → generate_glossary.py → glossary.qmd
Scripts
build_master_glossary.py- Main aggregation script (chapter JSONs → master JSON)generate_glossary.py- Page generator (master JSON → glossary.qmd)clean_master_glossary.py- Legacy cleanup script (use build_master instead)
Source Files
- Individual glossaries:
quarto/contents/core/*/\*_glossary.json(22 files) - Master glossary:
quarto/contents/data/master_glossary.json - Published page:
quarto/contents/backmatter/glossary/glossary.qmd
Individual chapter glossaries are the source of truth. Edit those, then rebuild.