Files
skill-seekers-reference/docs/README.md
yusyus 48b8544dea docs: Consolidate roadmaps and refactor documentation structure
MAJOR REFACTORING: Merge 3 roadmap files into single comprehensive ROADMAP.md

Changes:
- Merged ROADMAP.md + FLEXIBLE_ROADMAP.md + FUTURE_RELEASES.md → ROADMAP.md
- Consolidated 1,008 lines across 3 files into 429 lines (single source of truth)
- Removed duplicate/overlapping content
- Cleaned up docs archive structure

New ROADMAP.md Structure:
- Current Status (v2.6.0)
- Development Philosophy (task-based approach)
- Task-Based Roadmap (136 tasks, 10 categories)
- Release History (v1.0.0, v2.1.0, v2.6.0)
- Release Planning (v2.7-v2.9)
- Long-term Vision (v3.0+)
- Metrics & Goals
- Contribution guidelines

Deleted Files:
- FLEXIBLE_ROADMAP.md (merged into ROADMAP.md)
- FUTURE_RELEASES.md (merged into ROADMAP.md)
- docs/archive/temp/TERMINAL_SELECTION.md (temporary file)
- docs/archive/temp/TESTING.md (temporary file)

Moved Files:
- docs/plans/*.md → docs/archive/plans/ (dated planning docs)

Updated References:
- CLAUDE.md: FLEXIBLE_ROADMAP.md → ROADMAP.md
- docs/README.md: Removed duplicate roadmap references
- CHANGELOG.md: Updated documentation references

Benefits:
- Single source of truth for roadmap
- No duplicate maintenance
- Cleaner repository structure
- Better discoverability
- Historical context preserved in archive/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-14 22:36:03 +03:00

165 lines
5.7 KiB
Markdown

# Skill Seekers Documentation
Welcome to the Skill Seekers documentation hub. This directory contains comprehensive documentation organized by category.
## 📚 Quick Navigation
### 🚀 Getting Started
**New to Skill Seekers?** Start here:
- [Main README](../README.md) - Project overview and installation
- [Quickstart Guide](../QUICKSTART.md) - Fast introduction
- [Bulletproof Quickstart](../BULLETPROOF_QUICKSTART.md) - Beginner-friendly guide
- [Troubleshooting](../TROUBLESHOOTING.md) - Common issues and solutions
### 📖 User Guides
Essential guides for setup and daily usage:
- **Setup & Configuration**
- [Setup Quick Reference](guides/SETUP_QUICK_REFERENCE.md) - Quick setup commands
- [MCP Setup](guides/MCP_SETUP.md) - MCP server configuration
- [Multi-Agent Setup](guides/MULTI_AGENT_SETUP.md) - Multi-agent configuration
- [HTTP Transport](guides/HTTP_TRANSPORT.md) - HTTP transport mode setup
- **Usage Guides**
- [Usage Guide](guides/USAGE.md) - Comprehensive usage instructions
- [Upload Guide](guides/UPLOAD_GUIDE.md) - Uploading skills to platforms
### ⚡ Feature Documentation
Learn about core features and capabilities:
#### Core Features
- [Pattern Detection (C3.1)](features/PATTERN_DETECTION.md) - Design pattern detection
- [Test Example Extraction (C3.2)](features/TEST_EXAMPLE_EXTRACTION.md) - Extract usage from tests
- [How-To Guides (C3.3)](features/HOW_TO_GUIDES.md) - Auto-generate tutorials
- [Unified Scraping](features/UNIFIED_SCRAPING.md) - Multi-source scraping
#### AI Enhancement
- [AI Enhancement](features/ENHANCEMENT.md) - AI-powered skill enhancement
- [Enhancement Modes](features/ENHANCEMENT_MODES.md) - Headless, background, daemon modes
#### PDF Features
- [PDF Scraper](features/PDF_SCRAPER.md) - Extract from PDF documents
- [PDF Advanced Features](features/PDF_ADVANCED_FEATURES.md) - OCR, images, tables
- [PDF Chunking](features/PDF_CHUNKING.md) - Handle large PDFs
- [PDF MCP Tool](features/PDF_MCP_TOOL.md) - MCP integration
### 🔌 Platform Integrations
Multi-LLM platform support:
- [Multi-LLM Support](integrations/MULTI_LLM_SUPPORT.md) - Overview of platform support
- [Gemini Integration](integrations/GEMINI_INTEGRATION.md) - Google Gemini
- [OpenAI Integration](integrations/OPENAI_INTEGRATION.md) - ChatGPT
### 📘 Reference Documentation
Technical reference and architecture:
- [Feature Matrix](reference/FEATURE_MATRIX.md) - Platform compatibility matrix
- [Git Config Sources](reference/GIT_CONFIG_SOURCES.md) - Config repository management
- [Large Documentation](reference/LARGE_DOCUMENTATION.md) - Handling large docs
- [llms.txt Support](reference/LLMS_TXT_SUPPORT.md) - llms.txt format
- [Skill Architecture](reference/SKILL_ARCHITECTURE.md) - Skill structure
- [AI Skill Standards](reference/AI_SKILL_STANDARDS.md) - Quality standards
- [C3.x Router Architecture](reference/C3_x_Router_Architecture.md) - Router skills
- [Claude Integration](reference/CLAUDE_INTEGRATION.md) - Claude-specific features
### 📋 Planning & Design
Development plans and designs:
- [Design Plans](plans/) - Feature design documents
### 📦 Archive
Historical documentation and completed features:
- [Historical](archive/historical/) - Completed features and reports
- [Research](archive/research/) - Research notes and POCs
- [Temporary](archive/temp/) - Temporary analysis documents
## 🤝 Contributing
Want to contribute? See:
- [Contributing Guide](../CONTRIBUTING.md) - Contribution guidelines
- [Roadmap](../ROADMAP.md) - Comprehensive roadmap with 136 tasks
## 📝 Changelog
- [CHANGELOG](../CHANGELOG.md) - Version history and release notes
## 💡 Quick Links
### For Users
- [Installation](../README.md#installation)
- [Quick Start](../QUICKSTART.md)
- [MCP Setup](guides/MCP_SETUP.md)
- [Troubleshooting](../TROUBLESHOOTING.md)
### For Developers
- [Contributing](../CONTRIBUTING.md)
- [Development Setup](../CONTRIBUTING.md#development-setup)
- [Testing](../CONTRIBUTING.md#running-tests)
- [Architecture](reference/SKILL_ARCHITECTURE.md)
### API & Tools
- [API Documentation](../api/README.md)
- [MCP Server](../src/skill_seekers/mcp/README.md)
- [Config Repository](../skill-seekers-configs/README.md)
## 🔍 Finding What You Need
### I want to...
**Get started quickly**
→ [Quickstart Guide](../QUICKSTART.md) or [Bulletproof Quickstart](../BULLETPROOF_QUICKSTART.md)
**Set up MCP server**
→ [MCP Setup Guide](guides/MCP_SETUP.md)
**Scrape documentation**
→ [Usage Guide](guides/USAGE.md) → Documentation Scraping
**Scrape GitHub repos**
→ [Usage Guide](guides/USAGE.md) → GitHub Scraping
**Scrape PDFs**
→ [PDF Scraper](features/PDF_SCRAPER.md)
**Combine multiple sources**
→ [Unified Scraping](features/UNIFIED_SCRAPING.md)
**Enhance my skill with AI**
→ [AI Enhancement](features/ENHANCEMENT.md)
**Upload to Google Gemini**
→ [Gemini Integration](integrations/GEMINI_INTEGRATION.md)
**Upload to ChatGPT**
→ [OpenAI Integration](integrations/OPENAI_INTEGRATION.md)
**Understand design patterns**
→ [Pattern Detection](features/PATTERN_DETECTION.md)
**Extract test examples**
→ [Test Example Extraction](features/TEST_EXAMPLE_EXTRACTION.md)
**Generate how-to guides**
→ [How-To Guides](features/HOW_TO_GUIDES.md)
**Fix an issue**
→ [Troubleshooting](../TROUBLESHOOTING.md)
**Contribute code**
→ [Contributing Guide](../CONTRIBUTING.md)
## 📢 Support
- **Issues**: [GitHub Issues](https://github.com/yusufkaraaslan/Skill_Seekers/issues)
- **Discussions**: [GitHub Discussions](https://github.com/yusufkaraaslan/Skill_Seekers/discussions)
- **Project Board**: [GitHub Projects](https://github.com/users/yusufkaraaslan/projects/2)
---
**Documentation Version**: 2.6.0
**Last Updated**: 2026-01-13
**Status**: ✅ Complete & Organized