Vijay Janapa Reddi
|
3b37726b27
|
refactor(tools): reorganize scripts directory structure for better maintainability
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)
|
2025-10-09 13:36:16 -04:00 |
|
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 |
|