feat: Update documentation structure and content
- Added a link to the Recent Improvements section in the README.md for better visibility of new features. - Removed the SEARCH_FILTER_FIX.md file as its content has been integrated into other documentation. - Deleted the consolidate_docs.py script as its functionality is no longer needed after the documentation consolidation. - Removed the outdated CHANGELOG.md file and replaced it with a new structure that consolidates all changelog information. - Created a new DOCUMENTATION_INDEX.md file to provide a comprehensive guide to the documentation structure. - Updated the docs/README.md to reflect the new documentation organization and included links to preserved legacy documentation.
This commit is contained in:
@@ -30,24 +30,30 @@ This documentation has been **consolidated and reorganized** for better navigati
|
||||
#### Project Information
|
||||
- **[Main README](../README.md)** - Project overview and quick start
|
||||
- **[Changelog](../CHANGELOG.md)** - Version history and release notes
|
||||
- **[Recent Improvements](../IMPROVEMENTS_SUMMARY.md)** - Latest enhancements and new features
|
||||
|
||||
### 📁 Legacy Documentation (Preserved)
|
||||
## <20>️ Legacy Reference Files
|
||||
|
||||
The following files are preserved for reference but content has been consolidated:
|
||||
The following specialized documentation files are preserved in the docs/ folder:
|
||||
|
||||
#### Original Structure
|
||||
- `FEATURES.md` → Content moved to `USER_GUIDE.md`
|
||||
- `KEYBOARD_SHORTCUTS.md` → Content moved to `USER_GUIDE.md`
|
||||
- `DEVELOPMENT.md` → Content moved to `DEVELOPER_GUIDE.md`
|
||||
- `TESTING.md` → Content moved to `DEVELOPER_GUIDE.md`
|
||||
- `EXPORT_SYSTEM.md` → Content moved to `API_REFERENCE.md`
|
||||
- `MENU_THEMING.md` → Content moved to `API_REFERENCE.md`
|
||||
### Feature Documentation
|
||||
- **[FEATURES.md](FEATURES.md)** - Original feature documentation (consolidated into USER_GUIDE.md)
|
||||
- **[KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)** - Original shortcuts reference (consolidated into USER_GUIDE.md)
|
||||
- **[EXPORT_SYSTEM.md](EXPORT_SYSTEM.md)** - Original export documentation (consolidated into API_REFERENCE.md)
|
||||
- **[MENU_THEMING.md](MENU_THEMING.md)** - Original theming documentation (consolidated into API_REFERENCE.md)
|
||||
|
||||
#### Migration Benefits
|
||||
1. **Reduced Redundancy**: Eliminated duplicate content across multiple files
|
||||
2. **Better Organization**: Logical grouping by user type and purpose
|
||||
3. **Easier Navigation**: Clear entry points for different audiences
|
||||
4. **Comprehensive Coverage**: All information preserved and enhanced
|
||||
### Development Documentation
|
||||
- **[DEVELOPMENT.md](DEVELOPMENT.md)** - Original development guide (consolidated into DEVELOPER_GUIDE.md)
|
||||
- **[TESTING.md](TESTING.md)** - Original testing documentation (consolidated into DEVELOPER_GUIDE.md)
|
||||
|
||||
### System Documentation
|
||||
- **[DOCUMENTATION_SUMMARY.md](DOCUMENTATION_SUMMARY.md)** - Documentation organization summary
|
||||
|
||||
> **Note**: These files are preserved for reference but their content has been consolidated into the main documentation files for better organization and reduced redundancy.
|
||||
|
||||
---
|
||||
|
||||
**📖 For complete documentation navigation, see: [DOCUMENTATION_INDEX.md](DOCUMENTATION_INDEX.md)**
|
||||
5. **Maintainability**: Fewer files to keep synchronized
|
||||
|
||||
### 🚀 Quick Navigation
|
||||
|
||||
Reference in New Issue
Block a user