Files
cs249r_book/tools/scripts/content
Vijay Janapa Reddi 4cbc8b6f8b Reorganize and standardize scripts directory structure and naming
🗂️ Major reorganization:
- Organized scripts into logical categories: build/, content/, maintenance/, testing/, utilities/, docs/
- Moved 25+ scripts from flat structure to categorized directories
- Added category-specific README files with usage examples

📝 Standardized script naming:
- Fixed abbreviations: fn_cnt.sh → count_footnotes.sh, fixbib.py → fix_bibliography.py
- Applied consistent verb_noun patterns: section_id_manager.py → manage_section_ids.py
- Improved clarity: ascii_checker.py → check_ascii.py, fixtitle.py → fix_titles.py
- Distinguished similar tools: footnote_cnt.sh → analyze_footnotes.sh

📚 Updated documentation:
- Comprehensive main README with usage examples for all categories
- Individual README files for each script category
- Updated DEVELOPMENT.md with new scripts organization section
- Synchronized all script references in documentation

🔗 Integration updates:
- Updated Makefile to use new script paths
- Fixed pre-commit hook references to moved scripts
- Maintained all existing functionality while improving organization

The scripts directory now follows professional standards with intuitive categorization,
consistent naming conventions, and comprehensive documentation.
2025-07-25 11:56:50 -04:00
..

Content Management Scripts

Tools for managing, editing, and validating book content.

Key Scripts

  • manage_section_ids.py - Manage section IDs and cross-references
  • improve_figure_captions.py - Enhance figure captions using AI
  • find_unreferenced_labels.py - Find unused labels and references
  • find_duplicate_labels.py - Detect duplicate labels
  • fix_bibliography.py - Fix bibliography formatting

Common Usage

# Improve figure captions
python improve_figure_captions.py

# Find content issues
python find_unreferenced_labels.py
python find_duplicate_labels.py

# Clean up formatting
python collapse_blank_lines.py