Upgrade Readme
This commit is contained in:
201
docs/RELEASE_NOTES_2.3.0.md
Normal file
201
docs/RELEASE_NOTES_2.3.0.md
Normal file
@ -0,0 +1,201 @@
|
||||
# Release Notes v2.3.0 - Customization & Productivity
|
||||
|
||||
**Release Date:** November 11, 2025
|
||||
|
||||
## 🎉 Major Features
|
||||
|
||||
### ⭐ Favorites System
|
||||
Star your most important notes and folders for instant access. Favorites appear in a dedicated sidebar section with full folder expansion support.
|
||||
|
||||
**How to use:**
|
||||
- Hover over any note or folder in the sidebar
|
||||
- Click the ★ icon to toggle favorite status
|
||||
- Access all favorites from the "⭐ Favoris" section
|
||||
- Folders expand to show their contents
|
||||
- Favorites persist across sessions
|
||||
|
||||
### ⌨️ Comprehensive Keyboard Shortcuts
|
||||
10 new global shortcuts to boost your productivity:
|
||||
|
||||
| Shortcut | Action |
|
||||
|----------|--------|
|
||||
| `Ctrl/Cmd+K` | Open search modal |
|
||||
| `Ctrl/Cmd+S` | Save current note |
|
||||
| `Ctrl/Cmd+D` | Open today's daily note |
|
||||
| `Ctrl/Cmd+N` | Create new note |
|
||||
| `Ctrl/Cmd+H` | Go to homepage |
|
||||
| `Ctrl/Cmd+B` | Toggle sidebar |
|
||||
| `Ctrl/Cmd+,` | Open settings |
|
||||
| `Ctrl/Cmd+P` | Toggle preview mode |
|
||||
| `Ctrl/Cmd+Shift+F` | Create new folder |
|
||||
| `Escape` | Close any modal |
|
||||
|
||||
All shortcuts work system-wide and are documented in the new About page.
|
||||
|
||||
### 🔤 Font Customization
|
||||
Personalize your reading and writing experience:
|
||||
|
||||
**8 Font Options:**
|
||||
- JetBrains Mono (default) - Designed for IDEs
|
||||
- Fira Code - Popular with ligatures
|
||||
- Inter - Clean and professional
|
||||
- Poppins - Modern sans-serif
|
||||
- Public Sans - Government-approved readability
|
||||
- Cascadia Code - Microsoft's coding font
|
||||
- Source Code Pro - Adobe's classic
|
||||
- Sans-serif - System fallback
|
||||
|
||||
**4 Size Options:**
|
||||
- Small (14px) - Compact view
|
||||
- Medium (16px) - Default comfortable reading
|
||||
- Large (18px) - Enhanced readability
|
||||
- X-Large (20px) - Maximum comfort
|
||||
|
||||
Access via Settings → Polices tab.
|
||||
|
||||
### 🎮 Vim Mode Support
|
||||
Full Vim keybindings integration for power users!
|
||||
|
||||
**Features:**
|
||||
- Complete hjkl navigation
|
||||
- Insert, Normal, and Visual modes
|
||||
- All standard Vim commands (dd, yy, p, u, etc.)
|
||||
- Vim motions (w, b, $, 0, gg, G, etc.)
|
||||
- Search with `/` and `?`
|
||||
- Command mode with `:`
|
||||
|
||||
**Enable:** Settings → Éditeur → Toggle "Mode Vim"
|
||||
|
||||
**Requirements:** Automatically installed with `npm install` in the frontend directory.
|
||||
|
||||
### ℹ️ About Page
|
||||
New dedicated page accessible from the sidebar (ℹ️ button):
|
||||
- Overview of all features
|
||||
- Visual keyboard shortcuts reference
|
||||
- Quick start guide
|
||||
- Styled with modern card layout
|
||||
|
||||
## 🎨 UI/UX Improvements
|
||||
|
||||
### Enhanced Settings Modal
|
||||
- **Tabbed Interface:** Thèmes, Polices, Éditeur
|
||||
- **Better Organization:** Logical grouping of related settings
|
||||
- **Visual Previews:** See fonts and themes before selecting
|
||||
- **Toggle Switches:** Modern, animated switches for boolean options
|
||||
|
||||
### Sidebar Enhancements
|
||||
- **Wider Layout:** 300px (up from 280px) for better readability
|
||||
- **JetBrains Mono:** Default font for sidebar and code
|
||||
- **Compact Spacing:** More efficient use of space
|
||||
- **Visual Hierarchy:** Larger section titles, distinct root indicator
|
||||
- **Button Layout:** Settings and About buttons side-by-side at bottom
|
||||
|
||||
### Homepage Improvements
|
||||
- **Expandable Favorites:** Folders expand to show contents
|
||||
- **Note Counts:** See total notes in each section
|
||||
- **Scrollable Lists:** Max 300px height with custom scrollbars
|
||||
- **Better Organization:** Clear visual hierarchy
|
||||
|
||||
### Theme-Aware Components
|
||||
- Slash commands palette now respects theme colors
|
||||
- All modals use theme variables
|
||||
- Consistent styling across all UI elements
|
||||
|
||||
## 🔧 Technical Changes
|
||||
|
||||
### New Dependencies
|
||||
- `@replit/codemirror-vim` (optional) - Vim mode support
|
||||
|
||||
### New Files
|
||||
- `frontend/src/vim-mode-manager.js` - Vim mode lifecycle management
|
||||
- `frontend/src/font-manager.js` - Font and size preferences
|
||||
- `frontend/src/keyboard-shortcuts.js` - Centralized shortcuts handler
|
||||
- `frontend/src/favorites.js` - Favorites UI manager
|
||||
- `docs/KEYBOARD_SHORTCUTS.md` - Complete shortcuts documentation
|
||||
- `docs/RELEASE_NOTES_2.3.0.md` - This file
|
||||
|
||||
### New API Endpoints
|
||||
- `GET /api/favorites` - List all favorites
|
||||
- `POST /api/favorites` - Add to favorites
|
||||
- `DELETE /api/favorites` - Remove from favorites
|
||||
- `GET /api/about` - Render About page
|
||||
|
||||
### Backend Changes
|
||||
- New `favorites.go` handler for favorites management
|
||||
- New `handleAbout()` method in main handler
|
||||
- Favorites stored in `.favorites.json` at root
|
||||
- Route registration for favorites and about
|
||||
|
||||
### Frontend Changes
|
||||
- Enhanced `theme-manager.js` with tab switching
|
||||
- CSS toggle switch component
|
||||
- Improved font size handling with rem units
|
||||
- Better error handling for missing packages
|
||||
|
||||
## 🐛 Bug Fixes
|
||||
|
||||
- Fixed slash commands palette not respecting theme
|
||||
- Fixed font size only affecting titles (now affects all text)
|
||||
- Fixed modal centering for delete confirmations
|
||||
- Fixed sidebar overflow with proper scrolling
|
||||
- Fixed preview toggle shortcut for AZERTY keyboards (/ → P)
|
||||
- Graceful fallback when Vim package not installed
|
||||
|
||||
## 📚 Documentation Updates
|
||||
|
||||
- **README.md:** Complete feature list and usage guide
|
||||
- **CHANGELOG.md:** Detailed changelog for v2.3.0
|
||||
- **KEYBOARD_SHORTCUTS.md:** Full shortcuts reference
|
||||
- **About Page:** In-app help and feature overview
|
||||
|
||||
## 🚀 Upgrade Instructions
|
||||
|
||||
### For Existing Users
|
||||
|
||||
1. **Pull latest changes:**
|
||||
```bash
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
2. **Install new dependencies:**
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run build
|
||||
cd ..
|
||||
```
|
||||
|
||||
3. **Restart the server:**
|
||||
```bash
|
||||
go run cmd/server/main.go
|
||||
```
|
||||
|
||||
4. **Explore new features:**
|
||||
- Click ⚙️ to customize themes, fonts, and enable Vim mode
|
||||
- Click ℹ️ to view the About page and keyboard shortcuts
|
||||
- Hover over notes to add them to favorites
|
||||
- Try `Ctrl/Cmd+K` for quick search
|
||||
|
||||
### New Users
|
||||
|
||||
Follow the installation guide in README.md. All features are available out of the box!
|
||||
|
||||
## 🎯 Next Steps
|
||||
|
||||
Planned features for upcoming releases:
|
||||
- Light themes support
|
||||
- Custom theme creator
|
||||
- Mobile app (PWA)
|
||||
- Cloud sync
|
||||
- Collaborative editing
|
||||
- Plugin system
|
||||
|
||||
## 🙏 Feedback
|
||||
|
||||
Enjoy the new features! Report issues or suggest improvements on GitHub.
|
||||
|
||||
---
|
||||
|
||||
**Version:** 2.3.0
|
||||
**Release Date:** November 11, 2025
|
||||
**Codename:** Customization & Productivity
|
||||
Reference in New Issue
Block a user