You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Docs: Update and restructure documentation for upcoming release (v5.0.0)
**CHANGELOG.md**:
- Added [Unreleased] section with complete feature documentation
- Documented QR code support for Station mode
- Documented non-blocking WiFi connection architecture
- Documented structured logging system implementation
- Documented enhanced status command with comprehensive network info
- Documented FreeRTOS task architecture improvements
- Documented web server responsiveness optimizations
- Listed all bug fixes with root causes and solutions
- Added technical specifications (memory, performance, build stats)
- Migration guide and breaking changes section
**README.md**:
- Added "What's New in v5.0.0" section with 8 major features
- Detailed QR code functionality with use cases
- Non-blocking operations explanation with code examples
- Structured logging system overview
- Enhanced status command documentation
- FreeRTOS task architecture description
- Web server improvements summary
- Bug fixes and refinements list
- Quick links to documentation
**docs/RELEASE_NOTES_V5.0.0.md** (NEW):
- Comprehensive 500+ line release documentation
- Detailed overview and highlights
- Feature-by-feature deep dive with examples
- Code snippets showing before/after comparisons
- Use cases and benefits for each feature
- Complete bug fix documentation with root causes
- Technical specifications (memory, performance)
- Migration guide for v4.3.1 users
- Known issues section
- Future roadmap preview
**platformio.ini**:
- Updated version string to "5.0.0" in all environments
- Updated comment header to reflect new features
- All 6 build environments updated consistently
**Documentation Restructuring**:
- Moved TFT_TASK_ARCHITECTURE.md to docs/technical/
- Moved WIFI_TASK_ARCHITECTURE.md to docs/technical/
- Updated docs/DOCUMENTATION_INDEX.md with new locations
- Updated docs/README.md with complete feature list
- Reorganized technical documentation structure
- Improved navigation and discoverability
**docs/DOCUMENTATION_INDEX.md**:
- Added FreeRTOS Task Architecture section
- Added TFT Display Task Architecture reference
- Added WiFi Command Task Architecture reference
- Updated Technical Documentation section
- Improved cross-referencing between documents
**docs/README.md**:
- Updated feature highlights with latest additions
- Added QR Code Support to features list
- Added Non-Blocking WiFi Operations
- Added Structured Logging System
- Updated documentation organization structure
- Improved navigation with clear sections
**Key Features Documented**:
1. QR Code Support for Station Mode
2. Non-Blocking WiFi Connection
3. Structured Logging System
4. Enhanced Status Command
5. FreeRTOS Task Architecture
6. Web Server Improvements (10x faster)
7. Critical Bug Fixes (connection timing, TFT updates, mode switching)
8. Performance Optimizations
**Documentation Statistics**:
- CHANGELOG: +250 lines
- README: +150 lines
- RELEASE_NOTES: +500 lines (new file)
- docs/README.md: Updated with new features
- docs/DOCUMENTATION_INDEX.md: Reorganized structure
- Architecture docs: Moved to docs/technical/
- Total: ~1000 lines of documentation updates
**Build Verification**:
- All environments compile successfully
- Flash: 1,161,085 bytes (80.5%)
- RAM: 53,072 bytes (16.2%)
- No breaking changes
0 commit comments