skill-seekers-reference/docs/README.md

# Skill Seekers Documentation

Welcome to the Skill Seekers documentation hub. This directory contains comprehensive documentation organized by category.

## 📚 Quick Navigation

### 🆕 New in v3.x

**Recently Added Documentation:**
- ⭐ [Quick Reference](QUICK_REFERENCE.md) - One-page cheat sheet
- ⭐ [API Reference](reference/API_REFERENCE.md) - Programmatic usage guide
- ⭐ [Bootstrap Skill](features/BOOTSTRAP_SKILL.md) - Self-hosting documentation
- ⭐ [Code Quality](reference/CODE_QUALITY.md) - Linting and standards
- ⭐ [Testing Guide](guides/TESTING_GUIDE.md) - Complete testing reference
- ⭐ [Migration Guide](guides/MIGRATION_GUIDE.md) - Version upgrade guide
- ⭐ [FAQ](FAQ.md) - Frequently asked questions

### 🚀 Getting Started

**New to Skill Seekers?** Start here:
- [Main README](../README.md) - Project overview and installation
- [Quick Reference](QUICK_REFERENCE.md) - **One-page cheat sheet** ⚡
- [FAQ](FAQ.md) - Frequently asked questions
- [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
  - [Testing Guide](guides/TESTING_GUIDE.md) - Complete testing reference (1,880+ tests)
  - [Migration Guide](guides/MIGRATION_GUIDE.md) - Version upgrade instructions

### ⚡ 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
- [Bootstrap Skill](features/BOOTSTRAP_SKILL.md) - Self-hosting capability (dogfooding)

#### 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:
- [API Reference](reference/API_REFERENCE.md) - **Programmatic usage guide** ⭐
- [Code Quality](reference/CODE_QUALITY.md) - **Linting, testing, CI/CD standards** ⭐
- [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 Guide](guides/TESTING_GUIDE.md) - Complete testing reference
- [Code Quality](reference/CODE_QUALITY.md) - Linting and standards
- [API Reference](reference/API_REFERENCE.md) - Programmatic usage
- [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**
→ [Quick Reference](QUICK_REFERENCE.md) or [Quickstart Guide](../QUICKSTART.md)

**Find quick answers**
→ [FAQ](FAQ.md) - Frequently asked questions

**Use Skill Seekers programmatically**
→ [API Reference](reference/API_REFERENCE.md) - Python integration

**Set up MCP server**
→ [MCP Setup Guide](guides/MCP_SETUP.md)

**Run tests**
→ [Testing Guide](guides/TESTING_GUIDE.md) - 1,880+ tests

**Understand code quality standards**
→ [Code Quality](reference/CODE_QUALITY.md) - Linting and CI/CD

**Upgrade to new version**
→ [Migration Guide](guides/MIGRATION_GUIDE.md) - Version upgrades

**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)

**Create self-documenting skill**
→ [Bootstrap Skill](features/BOOTSTRAP_SKILL.md) - Dogfooding

**Fix an issue**
→ [Troubleshooting](../TROUBLESHOOTING.md) or [FAQ](FAQ.md)

**Contribute code**
→ [Contributing Guide](../CONTRIBUTING.md) and [Code Quality](reference/CODE_QUALITY.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**: 3.1.0-dev
**Last Updated**: 2026-02-18
**Status**: ✅ Complete & Organized