v2.2.0: Documentation & Workflow Improvements

Documentation & Workflow Improvements

English:
Comprehensive documentation overhaul and GitHub workflow optimization.

中文:
全面文档重构与 GitHub workflow 优化。

---

📚 Major Changes

Documentation System

• Unified changelog with Keep a Changelog format
• Reorganized documentation structure with clear navigation
• Updated all project documentation for consistency
• Added comprehensive API reference documentation
• Enhanced VitePress configuration with better SEO

GitHub Workflow

• Upgraded to Node.js 24 support (fixes deprecation warnings)
• Enhanced CI pipeline with parallel client/server testing
• Added proper concurrency configuration to prevent duplicate builds
• Improved path filtering to reduce unnecessary CI runs

Testing

• Added comprehensive test coverage for sync operations
• Client tests: Connection, sync-update, request-sync, error handling
• Server tests: Health check, join-chain, push-update, request-sync

Security

• Added dependency review workflow for security scanning
• Enabled CodeQL analysis for vulnerability detection
• Improved input validation and rate limiting

---

🔧 Technical Changes

Client (apps/web)

• Added test suite for useSocket hook
• Improved error handling in socket connections
• Fixed timer cleanup issues in tests

Server (apps/api)

• Added comprehensive test coverage
• Fixed graceful shutdown in test environment
• Extracted handleSocketConnection for better testability

Documentation (docs/)

• Migrated to VitePress for better documentation experience
• Added bilingual support (English & Chinese)
• Improved navigation and search functionality

---

📦 File Changes

Added

• CHANGELOG.md - Unified changelog (English)
• CHANGELOG.zh-CN.md - Unified changelog (Chinese)
• docs/api/ - API reference documentation
• Comprehensive test files for client and server

Changed

• Modernized documentation index with clear navigation
• Updated all documentation to reflect current architecture
• Simplified project status and progress documentation

Removed

• Deprecated spec files moved to archive
• Redundant documentation consolidated

---

🔄 Migration Notes

For Users

• No breaking changes in this release
• Existing sync chains continue to work
• Updated documentation available at https://lessup.github.io/brave-sync-notes/

For Developers

• Run npm install in both apps/web and apps/api
• Tests can be run with npm test in each directory
• Property-based tests available: npm run test:property

---

🙏 Contributors

Thanks to all contributors who made this release possible!

---

Full Changelog: v2.1.0...v2.2.0