Skip to content

FUTURE_RELEASES.md

Latest commit

 

History

History
288 lines (218 loc) · 8.11 KB

FUTURE_RELEASES.md

File metadata and controls

288 lines (218 loc) · 8.11 KB

Future Releases Roadmap

This document outlines planned features, improvements, and the vision for upcoming releases of Skill Seekers.

Release Philosophy

We follow semantic versioning (MAJOR.MINOR.PATCH) and maintain backward compatibility wherever possible. Each release focuses on delivering value to users while maintaining code quality and test coverage.

Next Release: v2.1.0 (Estimated: December 2025)

Focus: Test Coverage & Quality Improvements

Planned Features

Testing & Quality

  • Fix 12 unified scraping tests - Complete test coverage for unified multi-source scraping

    • ConfigValidator expecting dict instead of file path
    • ConflictDetector expecting dict pages, not list
    • Full integration test suite for unified workflow

  • Improve test coverage to 60%+ (currently 39%)

    • Write tests for 0% coverage files:
      • generate_router.py (110 lines) - Router skill generator
      • split_config.py (165 lines) - Config splitter
      • unified_scraper.py (208 lines) - Unified scraping CLI
      • package_multi.py (37 lines) - Multi-package tool
    • Improve coverage for low-coverage files:
      • mcp/server.py (9% → 60%)
      • enhance_skill.py (11% → 60%)
      • code_analyzer.py (19% → 60%)

  • Fix MCP test skipping issue - 29 MCP tests pass individually but skip in full suite

    • Resolve pytest isolation issue
    • Ensure all tests run in CI/CD

Features

  • Task H1.3: Create example project folder

    • Real-world example projects using Skill Seekers
    • Step-by-step tutorials
    • Before/after comparisons

  • Task J1.1: Install MCP package for testing

    • Better MCP integration testing
    • Automated MCP server tests in CI

  • Enhanced error handling

    • Better error messages for common issues
    • Graceful degradation for missing dependencies
    • Recovery from partial failures

Documentation

  • Video tutorials for common workflows
  • Troubleshooting guide expansion
  • Performance optimization guide

Release: v2.2.0 (Estimated: Q1 2026)

Focus: Web Presence & Community Growth

Planned Features

Community & Documentation

  • Task A3.1: GitHub Pages website (skillseekersweb.com)

    • Interactive documentation
    • Live demos and examples
    • Getting started wizard
    • Community showcase

  • Plugin system foundation

    • Allow custom scrapers via plugins
    • Plugin discovery and installation
    • Plugin documentation generator

Enhancements

  • Support for additional documentation formats

    • Sphinx documentation
    • Docusaurus sites
    • GitBook
    • Read the Docs
    • MkDocs Material

  • Improved caching strategies

    • Intelligent cache invalidation
    • Differential scraping (only changed pages)
    • Cache compression
    • Cross-session cache sharing

Performance

  • Scraping performance improvements
    • Connection pooling optimizations
    • Smart rate limiting based on server response
    • Adaptive concurrency
    • Memory usage optimization for large docs

Release: v2.3.0 (Estimated: Q2 2026)

Focus: Developer Experience & Integrations

Planned Features

Developer Tools

  • Web UI for config generation

    • Visual config builder
    • Real-time preview
    • Template library
    • Export/import configs

  • CI/CD integration examples

    • GitHub Actions workflows
    • GitLab CI
    • Jenkins pipelines
    • Automated skill updates on doc changes

  • Docker containerization

    • Official Docker images
    • docker-compose examples
    • Kubernetes deployment guides

API & Integrations

  • GraphQL API support

    • Scrape GraphQL documentation
    • Extract schema and queries
    • Generate interactive examples

  • REST API documentation formats

    • OpenAPI/Swagger
    • Postman collections
    • API Blueprint

Long-term Vision (v3.0+)

Major Features Under Consideration

Advanced Scraping

  • Real-time documentation monitoring

    • Watch for documentation changes
    • Automatic skill updates
    • Change notifications
    • Version diff reports

  • Multi-language documentation

    • Automatic language detection
    • Combined multi-language skills
    • Translation quality checking

Collaboration

  • Collaborative skill curation

    • Shared skill repositories
    • Community ratings and reviews
    • Collaborative editing
    • Fork and merge workflows

  • Skill marketplace

    • Discover community-created skills
    • Share your skills
    • Quality ratings
    • Usage statistics

AI & Intelligence

  • Enhanced AI analysis

    • Better conflict detection algorithms
    • Automatic documentation quality scoring
    • Suggested improvements
    • Code example validation

  • Semantic understanding

    • Natural language queries for skill content
    • Intelligent categorization
    • Auto-generated summaries
    • Concept relationship mapping

Backlog Ideas

Features Requested by Community

  • Support for video tutorial transcription
  • Integration with Notion, Confluence, and other wikis
  • Jupyter notebook scraping and conversion
  • Live documentation preview during scraping
  • Skill versioning and update management
  • A/B testing for skill quality
  • Analytics dashboard (scraping stats, error rates, etc.)

Technical Improvements

  • Migration to modern async framework (httpx everywhere)
  • Improved type safety (full mypy strict mode)
  • Better logging and debugging tools
  • Performance profiling dashboard
  • Memory optimization for very large docs (100K+ pages)

Ecosystem

  • VS Code extension
  • IntelliJ/PyCharm plugin
  • Command-line interactive mode (TUI)
  • Skill diff tool (compare versions)
  • Skill merge tool (combine multiple skills)

How to Influence the Roadmap

Priority System

Features are prioritized based on:

  1. User impact - How many users will benefit?
  2. Technical feasibility - How complex is the implementation?
  3. Community interest - How many upvotes/requests?
  4. Strategic alignment - Does it fit our vision?

Ways to Contribute

1. Vote on Features

  • ⭐ Star feature request issues
  • 💬 Comment with your use case
  • 🔼 Upvote discussions

2. Contribute Code

See our FLEXIBLE_ROADMAP.md for:

  • 134 tasks across 22 feature groups
  • Tasks categorized by difficulty and area
  • Clear acceptance criteria
  • Estimated effort levels

Pick any task and submit a PR! See CONTRIBUTING.md for guidelines.

3. Share Feedback

  • Open issues for bugs or feature requests
  • Share your success stories
  • Suggest improvements to existing features
  • Report performance issues

4. Help with Documentation

  • Write tutorials
  • Improve existing docs
  • Translate documentation
  • Create video guides

Release Schedule

We aim for predictable releases:

  • Patch releases (2.0.x): As needed for critical bugs
  • Minor releases (2.x.0): Every 2-3 months
  • Major releases (x.0.0): Annually, with breaking changes announced 3 months in advance

Current Schedule

Version Focus ETA Status
v2.0.0 PyPI Publication 2025-11-11 ✅ Released
v2.1.0 Test Coverage & Quality Dec 2025 🚧 Planning
v2.2.0 Web Presence Q1 2026 📋 Planned
v2.3.0 Developer Experience Q2 2026 📋 Planned
v3.0.0 Major Evolution 2026 💡 Conceptual

Stay Updated

Questions?

Have questions about the roadmap or want to suggest a feature?

  1. Check if it's already in our FLEXIBLE_ROADMAP.md
  2. Search existing discussions
  3. Open a new discussion or issue
  4. Reach out in our community channels

Together, we're building the future of documentation-to-AI skill conversion! 🚀