🗺️ Redfish Development Roadmap
Project milestones and upcoming features
Phase 1: Core Implementation ✓ Completed
- Migrate from Zig to Go
- Create modular project structure
- Implement markdown parser with embed support
- Build fuzzy search engine with weighted scoring
- Integrate Glamour/Glow for beautiful rendering
- Add comprehensive embedded cheatsheets (git, docker, kubernetes, kubectl, markdown, kcsi)
- Setup GitHub repository and CI/CD
- Configure quality gates (SonarCloud, gofmt, go vet)
Phase 2: Intelligent Search ✓ Completed
- Multi-language support (English, Italian)
- Natural Language Processing (NLP-like queries)
- Stopwords filtering (EN/IT)
- Synonym expansion and verb forms
- Smart AND logic for multi-token searches
- Coverage-based result filtering (70% threshold)
- Interactive fzf integration
- Smart output limiting (specific vs. general queries)
Phase 3: User Experience ✓ Completed
- Configuration wizard (-c flag)
- YAML-based user preferences (~/.redfish/config.yaml)
- Language selection and override
- Custom user cheatsheets support (~/.redfish/{lang}/)
- Secure architecture (embedded protected, custom editable)
- Auto-merge embedded + custom commands
- Cache system with language separation
- Description display modes (short/long/none)
- Enhanced markdown format with Short_Description and Long_Description
- Complete description coverage for all embedded cheatsheets (EN/IT)
Phase 4: Distribution & Quality In Progress
- SonarCloud integration and quality gate passing
- GitHub Actions CI/CD workflows
- Multi-platform builds (Linux/macOS/Windows × amd64/arm64/arm)
- GitHub Pages documentation site
- Automatic release workflow with version tagging
- SHA256 checksum generation for releases
- Code quality improvements (reduced cognitive complexity)
- WCAG 2.1 AA compliant documentation CSS
- Comprehensive unit tests coverage
- Publish to Homebrew
- Package for apt/yum repositories
Phase 5: Future Enhancements Planned
- Add more language support (Spanish, French, German)
- Expand embedded cheatsheets (aws, gcloud, terraform, ansible)
- Command history and favorites tracking
- Export to various formats (HTML, PDF, man pages)
- Community cheatsheet repository
- Plugin system for custom search algorithms
- Web-based cheatsheet browser
- Command execution with dry-run mode