yusufkaraaslan--skill_seekers/docs/README.md

# Skill Seekers Documentation

> **Complete documentation for Skill Seekers v3.7.0**

---

## Welcome!

This is the official documentation for **Skill Seekers** - the universal tool for converting **18 source types** (documentation sites, GitHub repos, PDFs, videos, Word docs, EPUB books, Jupyter notebooks, local HTML, OpenAPI specs, AsciiDoc, PowerPoint, RSS/Atom feeds, man pages, Confluence, Notion, Slack/Discord, and local codebases) into AI-ready skills for 21+ platforms.

---

## Where Should I Start?

### 🚀 I'm New Here

Start with our **Getting Started** guides:

1. [Installation](getting-started/01-installation.md) - Install Skill Seekers
2. [Quick Start](getting-started/02-quick-start.md) - Create your first skill in 3 commands
3. [Your First Skill](getting-started/03-your-first-skill.md) - Complete walkthrough
4. [Next Steps](getting-started/04-next-steps.md) - Where to go from here
5. [Scan a Project](getting-started/05-scan-a-project.md) - Bootstrap configs from a codebase

### 📖 I Want to Learn

Explore our **User Guides**:

- [Core Concepts](user-guide/01-core-concepts.md) - How Skill Seekers works
- [Scraping Guide](user-guide/02-scraping.md) - All scraping options
- [Enhancement Guide](user-guide/03-enhancement.md) - AI enhancement explained
- [Packaging Guide](user-guide/04-packaging.md) - Export to platforms
- [Workflows Guide](user-guide/05-workflows.md) - Enhancement workflows
- [Troubleshooting](user-guide/06-troubleshooting.md) - Common issues

### 📚 I Need Reference

Look up specific information:

- [CLI Reference](reference/CLI_REFERENCE.md) - All 19 commands
- [MCP Reference](reference/MCP_REFERENCE.md) - 40 MCP tools
- [Config Format](reference/CONFIG_FORMAT.md) - JSON specification
- [Environment Variables](reference/ENVIRONMENT_VARIABLES.md) - All env vars
- [FAQ](FAQ.md) - Frequently asked questions
- [Troubleshooting](TROUBLESHOOTING.md) - Full troubleshooting reference

### 🚀 I'm Ready for Advanced Topics

Power user features:

- [MCP Server Setup](advanced/mcp-server.md) - MCP integration
- [MCP Tools Deep Dive](advanced/mcp-server.md) - Advanced MCP usage
- [Custom Workflows](advanced/custom-workflows.md) - Create workflows
- [Multi-Source Scraping](advanced/multi-source.md) - Combine sources

---

## Quick Reference

### The 3 Commands

```bash
# 1. Install
pip install skill-seekers

# 2. Create skill
skill-seekers create https://docs.django.com/

# 3. Package for Claude
skill-seekers package output/django --target claude
```

### Common Commands

```bash
# Create from any source (auto-detects type)
skill-seekers create https://docs.django.com/
skill-seekers create facebook/react
skill-seekers create manual.pdf
skill-seekers create notebook.ipynb

# Scan a project for tech stack — emits one config per framework
skill-seekers scan ./my-react-app --out ./configs/scanned/

# Enhance skill
skill-seekers enhance output/my-skill/

# Package for platform
skill-seekers package output/my-skill/ --target claude

# Upload
skill-seekers upload output/my-skill-claude.zip

# Install complete workflow
skill-seekers install --config react --target claude

# Doctor / diagnostics
skill-seekers doctor
```

---

## Documentation Structure

```
docs/
├── README.md                 # This file - start here
├── ARCHITECTURE.md          # How docs are organized
├── UML_ARCHITECTURE.md      # Software architecture (UML diagrams)
├── UNIFICATION_PLAN.md      # Grand Unification refactor plan + phase results
├── BUG_AUDIT.md             # Full-codebase bug audit (historical record)
│
├── getting-started/         # For new users
│   ├── 01-installation.md
│   ├── 02-quick-start.md
│   ├── 03-your-first-skill.md
│   ├── 04-next-steps.md
│   └── 05-scan-a-project.md
│
├── user-guide/              # Common tasks
│   ├── 01-core-concepts.md
│   ├── 02-scraping.md
│   ├── 03-enhancement.md
│   ├── 04-packaging.md
│   ├── 05-workflows.md
│   └── 06-troubleshooting.md
│
├── guides/                  # How-to guides
│   ├── MCP_SETUP.md
│   ├── MIGRATION_GUIDE.md
│   ├── TESTING_GUIDE.md
│   └── UPLOAD_GUIDE.md
│
├── integrations/            # Platform integrations
│   ├── LANGCHAIN.md
│   ├── LLAMA_INDEX.md
│   ├── CURSOR.md
│   └── ...
│
├── features/                # Feature deep-dives
│   ├── BOOTSTRAP_SKILL.md
│   ├── UNIFIED_SCRAPING.md
│   └── ENHANCEMENT.md
│
├── reference/               # Technical reference
│   ├── CLI_REFERENCE.md     # 19 commands
│   ├── MCP_REFERENCE.md     # 40 MCP tools
│   ├── CONFIG_FORMAT.md     # JSON spec
│   └── ENVIRONMENT_VARIABLES.md
│
├── advanced/                # Power user topics
│   ├── mcp-server.md
│   ├── custom-workflows.md
│   └── multi-source.md
│
├── archive/                 # Legacy docs
├── blog/                    # Blog posts
├── case-studies/            # Case studies
├── plans/                   # Feature plans
├── roadmap/                 # Roadmap
├── strategy/                # Strategy docs
└── zh-CN/                   # Chinese translations
```

---

## By Use Case

### I Want to Build AI Skills

For Claude, Gemini, ChatGPT:

1. [Quick Start](getting-started/02-quick-start.md)
2. [Enhancement Guide](user-guide/03-enhancement.md)
3. [Workflows Guide](user-guide/05-workflows.md)

### I Want to Build RAG Pipelines

For LangChain, LlamaIndex, vector DBs:

1. [Core Concepts](user-guide/01-core-concepts.md)
2. [Packaging Guide](user-guide/04-packaging.md)
3. [MCP Reference](reference/MCP_REFERENCE.md)

### I Want AI Coding Assistance

For Cursor, Windsurf, Cline, Roo, Aider, Bolt, Kilo, Continue, Kimi Code:

1. [Your First Skill](getting-started/03-your-first-skill.md)
2. [Local Codebase Analysis](user-guide/02-scraping.md#local-codebase-analysis)
3. `skill-seekers install-agent --agent cursor`

---

## Version Information

- **Current Version:** 3.7.0
- **Last Updated:** 2026-06-11
- **Source Types:** 18
- **Python Required:** 3.10+

---

## Contributing to Documentation

Found an issue? Want to improve docs?

1. Edit files in the `docs/` directory
2. Follow the existing structure
3. Submit a PR

See [Contributing Guide](../CONTRIBUTING.md) for details.

---

## External Links

- **Main Repository:** https://github.com/yusufkaraaslan/Skill_Seekers
- **Website:** https://skillseekersweb.com/
- **PyPI:** https://pypi.org/project/skill-seekers/
- **Issues:** https://github.com/yusufkaraaslan/Skill_Seekers/issues

---

## License

MIT License - see [LICENSE](../LICENSE) file.

---

*Happy skill building! 🚀*