Skip to content

this_file: docs-src/internal/WORK.md

Work Progress - v2.3.4

Completed in this session

Documentation Migration to MkDocs

  1. ✅ Successfully migrated documentation from Jekyll to MkDocs Material
  2. Moved all docs from /docs to /docs-src preserving git history
  3. Deleted Jekyll-specific files (_config.yml, Gemfile, _headers)
  4. Created mkdocs.yml configuration with Material theme
  5. Added mkdocs-awesome-nav and mkdocs-nav-weight plugins
  6. Updated GitHub Actions workflow for automated MkDocs builds
  7. Created requirements-docs.txt for easy dependency installation
  8. Cleaned up Jekyll front-matter from all markdown files
  9. Successfully built documentation locally with MkDocs
  10. Added .nojekyll file to bypass GitHub Pages Jekyll processing

Critical Build Fixes

  1. ✅ Fixed critical clippy errors that were blocking compilation:
  2. Fixed while-let-on-iterator warning in parallel.rs (line 246)
  3. Fixed uninlined-format-args in parallel.rs (line 158)
  4. Fixed should_implement_trait warning in parallel_chunked.rs by implementing Default trait
  5. Fixed type-complexity warnings by introducing type aliases (ParseResult, MergedResults)

  6. Fixed unused mut warning in parallel.rs (line 244)

  7. ✅ Verified test_number_features is now passing

  8. ✅ Created scripts for the reference implementation reference removal:

  9. remove_the reference implementation_refs.sh (general replacement)
  10. remove_the reference implementation_refs_targeted.sh (careful targeted replacement)
  11. Partially executed targeted removal (reduced references but many remain)

Build Status

  • Core library now builds successfully with only non-critical warnings
  • All tests are passing
  • Ready to proceed with non-critical improvements

Next Steps

  1. Complete the reference implementation reference removal - Still ~1800 references across 41 files
  2. Focus on test files and documentation
  3. Preserve important compatibility notes

  4. Update web assets (rename the reference implementation-tool.js)

  5. Fix remaining clippy warnings - 100+ uninlined-format-args warnings

  6. Can use cargo fix for automatic fixing

  7. Review changes before committing

  8. Work on naming unification (issues/611.txt)

  9. Ensure consistent naming across all language bindings

  10. Improve build deliverables (issues/620.txt)

  11. Create proper packaging for each platform
  12. macOS: .dmg with .pkg installer
  13. Windows: .zip with .exe

  14. Linux: .tgz with executable

  15. Release v2.3.3

  16. Update version numbers
  17. Update CHANGELOG.md
  18. Create release tag
  19. Publish to crates.io