skill-seekers-reference/docs/README.md

# Skill Seekers Documentation

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

---

## Welcome!

This is the official documentation for **Skill Seekers** - the universal tool for converting **17 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 30+ 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

### 📖 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 20 commands
- [MCP Reference](reference/MCP_REFERENCE.md) - 26 MCP tools
- [Config Format](reference/CONFIG_FORMAT.md) - JSON specification
- [Environment Variables](reference/ENVIRONMENT_VARIABLES.md) - All env vars

### 🚀 I'm Ready for Advanced Topics

Power user features:

- [MCP Server Setup](advanced/mcp-server.md) - MCP integration
- [MCP Tools Deep Dive](advanced/mcp-tools.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
# Auto-detect any source type
skill-seekers create https://docs.django.com/
skill-seekers create facebook/react
skill-seekers create manual.pdf
skill-seekers create notebook.ipynb

# Scrape documentation
skill-seekers scrape --config react

# Analyze GitHub repo
skill-seekers github --repo facebook/react

# Extract PDF
skill-seekers pdf manual.pdf --name docs

# Convert other formats
skill-seekers word report.docx --name report
skill-seekers epub book.epub --name handbook
skill-seekers jupyter analysis.ipynb --name analysis
skill-seekers openapi spec.yaml --name my-api
skill-seekers pptx slides.pptx --name deck
skill-seekers video https://youtube.com/watch?v=... --name tutorial

# Import from platforms
skill-seekers confluence --space DOCS --name wiki
skill-seekers notion --database DB_ID --name notes
skill-seekers chat --platform slack --export-dir ./export

# Analyze local code
skill-seekers analyze --directory ./my-project

# 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

# List workflows
skill-seekers workflows list
```

---

## Documentation Structure

```
docs/
├── README.md                 # This file - start here
├── ARCHITECTURE.md          # How docs are organized
│
├── getting-started/         # For new users
│   ├── 01-installation.md
│   ├── 02-quick-start.md
│   ├── 03-your-first-skill.md
│   └── 04-next-steps.md
│
├── user-guide/              # Common tasks
│   ├── 01-core-concepts.md
│   ├── 02-scraping.md
│   ├── 03-enhancement.md
│   ├── 04-packaging.md
│   ├── 05-workflows.md
│   └── 06-troubleshooting.md
│
├── reference/               # Technical reference
│   ├── CLI_REFERENCE.md     # 20 commands
│   ├── MCP_REFERENCE.md     # 26 MCP tools
│   ├── CONFIG_FORMAT.md     # JSON spec
│   └── ENVIRONMENT_VARIABLES.md
│
└── advanced/                # Power user topics
    ├── mcp-server.md
    ├── mcp-tools.md
    ├── custom-workflows.md
    └── multi-source.md
```

---

## 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.2.0
- **Last Updated:** 2026-03-15
- **Source Types:** 17
- **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! 🚀*