- Simplify pyproject.toml build-system requirements (remove version constraints)
- Remove dependencies from pyproject.toml to prevent build hanging
- Update README to install requirements.txt first, then package
- Tested: Full installation now completes in under 30 seconds
This resolves the 'Installing build dependencies' hanging issue completely.
- Add missing psutil to requirements.txt (was causing ModuleNotFoundError)
- Change pip install -e . to pip install . in README (production vs dev install)
- Fix installation issue by using proper production install method
Tested: pip install . now works properly without hanging or missing dependencies
- Update Quick Start section to show new pip install workflow
- Add ENHANCEMENTS.md for tracking path resolution feature
- Replace old bash installer instructions with proper Python packaging
- Applied Black formatter and isort across entire codebase for professional consistency
- Moved implementation scripts (rag-mini.py, rag-tui.py) to bin/ directory for cleaner root
- Updated shell scripts to reference new bin/ locations maintaining user compatibility
- Added comprehensive linting configuration (.flake8, pyproject.toml) with dedicated .venv-linting
- Removed development artifacts (commit_message.txt, GET_STARTED.md duplicate) from root
- Consolidated documentation and fixed script references across all guides
- Relocated test_fixes.py to proper tests/ directory
- Enhanced project structure following Python packaging standards
All user commands work identically while improving code organization and beginner accessibility.
What I changed
- Align naming and messages
- Standardized user-facing hints to use the `rag-mini` entrypoint across CLI, TUI, tests, and README where applicable.
- Updated server/status “next step” messages to point to `rag-mini init/server/search`.
- Fix fallback label
- `mini_rag/ollama_embeddings.py`: `get_embedding_info()` now correctly reports ML fallback when mode is `fallback`.
- TUI improvements
- `rag-tui.py`: Added a GUI folder picker option (tkinter) to make selecting a directory easier for non-technical users. It’s optional; if unavailable, it degrades gracefully.
- TUI embedding status now reads the correct mode keys from `get_status()` and labels “fallback” as ML.
- Docs cleanup
- `README.md`: Fixed broken “Documentation” links to point at existing docs and included direct `rag-mini` Windows examples alongside `rag.bat`.
- Tests and messages
- Standardized status/error text in a couple tests and server messages to reference `rag-mini`.
- Audio script
- Added `assets/tts_onboarding.txt` with the narrated first-run onboarding script you can feed directly to TTS.
Files touched
- `mini_rag/ollama_embeddings.py`
- `mini_rag/cli.py`
- `mini_rag/server.py`
- `rag-tui.py`
- `README.md`
- `tests/test_hybrid_search.py`
- `tests/02_search_examples.py`
- `assets/tts_onboarding.txt` (new content file)
About the PR
- I created a new local branch `feat/ux-polish`. The environment doesn’t have Git available in PATH right now, so I couldn’t stage/commit with Git from here. If you run these commands locally (once Git is available), it will create the PR branch:
- Windows PowerShell (run in the repo root):
- git checkout -b feat/ux-polish
- git add -A
- git commit -m "UX polish: unify command hints to rag-mini, fix fallback mode label, improve TUI status, update README links, add TTS onboarding script"
- git push -u origin feat/ux-polish
TTS script (already saved at assets/tts_onboarding.txt)
- If you still want the text inline for copy/paste, it’s exactly what we discussed. It’s already in the repo at `assets/tts_onboarding.txt`.
Would generating audio be useful?
- It’s not silly. Including audio onboarding can help non-technical users; shipping the `.wav`/`.mp3` is optional. Since your TTS server is ready, I provided a clean script so you can convert it on your side and optionally bundle it in releases.
Summary of impact
- Consistent `rag-mini` guidance reduces confusion.
- Correct ML fallback label avoids misleading status.
- TUI now has an optional folder picker, a big UX lift for non-technical users.
- README links no longer point to missing pages.
- Added a ready-to-use TTS onboarding narration file.
- Add Windows installer (install_windows.bat) and launcher (rag.bat)
- Enhance both Linux and Windows installers with intelligent Qwen3 model detection and setup
- Fix installation script continuation issues and improve user guidance
- Update README with side-by-side Linux/Windows commands
- Auto-save model preferences to config.yaml for consistent experience
Makes FSS-Mini-RAG fully cross-platform with zero-friction Windows adoption 🚀
- Use cohesive, pleasant color palette with proper contrast
- Add subtle borders to define elements clearly
- Green for start/success states
- Warm yellow for CLI emphasis (less harsh than orange)
- Blue for search mode, purple for explore mode
- All colors chosen for accessibility and visual appeal
- Replace generic technical diagram with user-focused workflow
- Show clear path from start to results via TUI or CLI
- Highlight CLI advanced features to encourage power user adoption
- Demonstrate the two core modes: Search (fast) vs Explore (deep)
- Visual emphasis on CLI power and advanced capabilities
- Added back the two essential demo GIFs showing synthesis and exploration modes
- Moved logo to be smaller and inline with title (40x40px)
- Removed all demo creation scripts and development artifacts
- Clean, professional presentation ready for GitHub release
- Repository now contains only production-ready files
- Added beautiful new Mini-RAG logo with teal and purple colors
- Updated README to use new logo
- Cleaned up repository by removing development scripts and artifacts
- Repository structure now clean and professional
- Ready for GitHub release preparation
- Fixed mermaid parse error by removing quotes from node labels
- Added two demo GIFs to showcase the system in action
- Removed broken icon reference
- README now displays perfectly with engaging visuals
- Update README with prominent two-mode explanation (synthesis vs exploration)
- Add exploration mode to TUI with full interactive interface
- Create comprehensive mode separation tests (test_mode_separation.py)
- Update Ollama integration tests to cover both synthesis and exploration modes
- Add CLI reference updates showing both modes
- Implement complete testing coverage for lazy loading, mode contamination prevention
- Add session management tests for exploration mode
- Update all examples and help text to reflect clean two-mode architecture
🔧 Integration Updates
- Added --synthesize flag to main rag-mini CLI
- Updated README with synthesis examples and 10 result default
- Enhanced demo script with 8 complete results (was cutting off at 5)
- Updated rag-tui default from 5 to 10 results
- Updated rag-mini-enhanced script defaults
📈 User Experience Improvements
- All components now consistently default to 10 results
- Demo shows complete 8-result workflow with multi-line previews
- Documentation reflects new AI analysis capabilities
- Seamless integration preserves existing workflows
Users get more comprehensive results by default and can optionally
add intelligent AI analysis with a simple --synthesize flag!
