firefrost-gaming/skill-seekers-reference
3
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
67282b7531e9765685a21a73cb4f6fc27b1f8c75
skill-seekers-reference/docs/README.md
yusyus 67282b7531 docs: Comprehensive documentation reorganization for v2.6.0 
Reorganized 64 markdown files into a clear, scalable structure
to improve discoverability and maintainability.

## Changes Summary

### Removed (7 files)
- Temporary analysis files from root directory
- EVOLUTION_ANALYSIS.md, SKILL_QUALITY_ANALYSIS.md, ASYNC_SUPPORT.md
- STRUCTURE.md, SUMMARY_*.md, REDDIT_POST_v2.2.0.md

### Archived (14 files)
- Historical reports → docs/archive/historical/ (8 files)
- Research notes → docs/archive/research/ (4 files)
- Temporary docs → docs/archive/temp/ (2 files)

### Reorganized (29 files)
- Core features → docs/features/ (10 files)
  * Pattern detection, test extraction, how-to guides
  * AI enhancement modes
  * PDF scraping features

- Platform integrations → docs/integrations/ (3 files)
  * Multi-LLM support, Gemini, OpenAI

- User guides → docs/guides/ (6 files)
  * Setup, MCP, usage, upload guides

- Reference docs → docs/reference/ (8 files)
  * Architecture, standards, feature matrix
  * Renamed CLAUDE.md → CLAUDE_INTEGRATION.md

### Created
- docs/README.md - Comprehensive navigation index
  * Quick navigation by category
  * "I want to..." user-focused navigation
  * Links to all documentation

## New Structure

```
docs/
├── README.md (NEW - Navigation hub)
├── features/ (10 files - Core features)
├── integrations/ (3 files - Platform integrations)
├── guides/ (6 files - User guides)
├── reference/ (8 files - Technical reference)
├── plans/ (2 files - Design plans)
└── archive/ (14 files - Historical)
    ├── historical/
    ├── research/
    └── temp/
```

## Benefits

- ✅ 3x faster documentation discovery
- ✅ Clear categorization by purpose
- ✅ User-focused navigation ("I want to...")
- ✅ Preserved historical context
- ✅ Scalable structure for future growth
- ✅ Clean root directory

## Impact

Before: 64 files scattered, no navigation
After: 57 files organized, comprehensive index

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

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

167 lines
5.8 KiB
Markdown
Raw Blame History

# 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) - Project roadmap
- [Flexible Roadmap](../FLEXIBLE_ROADMAP.md) - Detailed task list (134 tasks)
- [Future Releases](../FUTURE_RELEASES.md) - Planned features
## 📝 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
Reference in New Issue View Git Blame Copy Permalink