Commit 42bc54275 (figure-audit feat) inadvertently ran a tool that
broke BibTeX title syntax across hundreds of entries: e.g.
'{TensorFlow: Large-Scale...}' became '{{TensorFlow}}: {Large}-Scale...}',
producing unbalanced braces that caused the bib_lint parser to
truncate parsing partway through the entry. This surfaced in
pre-commit as 772 'missing required field' violations.
Restoring vol1+vol2 references.bib to the pre-mangling state
(9ebdf77d0) preserves all legitimate citation work from earlier
commits while undoing the unintended damage. The mechanical
formatter and bibtex-tidy hooks then re-emit a stable form.
Also: trailing newline added to scripts/README.md by pre-commit's
end-of-file-fixer.
- Move high-level assets to assets/ directory (covers, icons, styles, media)
- Consolidate build configuration in config/ directory (extensions, lua, tex)
- Group development tools under tools/ directory (scripts, dependencies, setup)
- Organize all book content under book/ directory
- Update all path references in _quarto.yml and other config files
- Preserve git history for all moved files
- Maintain full functionality for both HTML and PDF builds
This reorganization reduces root directory clutter from 50+ files to essential
project files only, providing clear separation of concerns and improved
maintainability for the textbook project.
📖 COMPREHENSIVE DOCUMENTATION UPDATE:
✅ Script Internal Documentation:
- Updated main script header docstring with new modes
- Updated class FigureCaptionImprover docstring
- Fixed function docstrings and comments throughout
- Removed references to old --workflow, --update, --validate options
- Updated print messages to reflect new terminology
📚 New External Documentation:
- Created scripts/FIGURE_CAPTIONS.md with complete usage guide
- Added model selection guide with speed/quality ratings
- Included troubleshooting section and best practices
- Updated scripts/README.md with script overview
🔧 Updated References:
- Main modes: --improve/-i, --build-map/-b, --analyze/-a, --repair/-r
- Removed outdated workflow terminology
- Clear examples for all usage patterns
- Performance optimization guidelines
📋 Documentation Features:
- Command-line option tables with short/long forms
- Model comparison with star ratings
- Before/after caption examples
- Integration with Quarto build process
- Success metrics and quality standards
✅ All documentation now reflects the streamlined v2.0 interface
Adds a comprehensive requirements file and a scripts README
documenting dependencies, pre-commit setup, and project structure.
This enhancement streamlines project setup and ensures consistent
dependency management, improving maintainability and collaboration.
