Focus 4: Code Quality and Tech Debt

[rainliu]

Focus 4: Code Quality and Tech Debt

TODO/FIXME Cleanup

The codebase currently contains 104 TODO/FIXME comments that need to be addressed:

$ grep -r "TODO\|FIXME" --include="*.rs" | wc -l
104

Categorization plan:

Category	Action
Missing features	Implement or document as "won't fix"
Performance notes	Create benchmark, then optimize
Error handling	Improve error messages and recovery
Code cleanup	Refactor or remove dead code
Documentation	Add missing docs

Tracking approach:

1. Create GitHub issues for each significant TODO
2. Prioritize by impact (user-facing vs internal)
3. Address in dedicated cleanup sprints
4. Add CI check to prevent new untracked TODOs

Documentation Improvements

• Complete rustdoc coverage for public APIs
• Add architecture decision records (ADRs)
• Improve inline code comments for complex algorithms
• Create troubleshooting guide
• Add performance tuning guide

API Refinements

Some APIs may benefit from refinement based on user feedback:

• Error types consolidation
• Builder pattern consistency
• Event handling ergonomics
• Configuration validation