Skip to content

Latest commit

 

History

History
199 lines (136 loc) · 4.95 KB

README.md

File metadata and controls

199 lines (136 loc) · 4.95 KB

Skill Seekers Documentation

Complete documentation for Skill Seekers v3.1.0

Welcome!

This is the official documentation for Skill Seekers - the universal tool for converting documentation, code, and PDFs into AI-ready skills.

Where Should I Start?

🚀 I'm New Here

Start with our Getting Started guides:

  1. Installation - Install Skill Seekers
  2. Quick Start - Create your first skill in 3 commands
  3. Your First Skill - Complete walkthrough
  4. Next Steps - Where to go from here

📖 I Want to Learn

Explore our User Guides:

📚 I Need Reference

Look up specific information:

🚀 I'm Ready for Advanced Topics

Power user features:

Quick Reference

The 3 Commands

# 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

# 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

# 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
  2. Enhancement Guide
  3. Workflows Guide

I Want to Build RAG Pipelines

For LangChain, LlamaIndex, vector DBs:

  1. Core Concepts
  2. Packaging Guide
  3. MCP Reference

I Want AI Coding Assistance

For Cursor, Windsurf, Cline:

  1. Your First Skill
  2. Local Codebase Analysis
  3. skill-seekers install-agent --agent cursor

Version Information

  • Current Version: 3.1.0
  • Last Updated: 2026-02-16
  • 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 for details.

External Links

License

MIT License - see LICENSE file.

Happy skill building! 🚀