firefrost-gaming/skill-seekers-reference

Files

yusyus 37cb307455 docs: update all documentation for 17 source types

Update 32 documentation files across English and Chinese (zh-CN) docs
to reflect the 10 new source types added in the previous commit.

Updated files:
- README.md, README.zh-CN.md — taglines, feature lists, examples, install extras
- docs/reference/ — CLI_REFERENCE, FEATURE_MATRIX, MCP_REFERENCE, CONFIG_FORMAT, API_REFERENCE
- docs/features/ — UNIFIED_SCRAPING with generic merge docs
- docs/advanced/ — multi-source guide, MCP server guide
- docs/getting-started/ — installation extras, quick-start examples
- docs/user-guide/ — core-concepts, scraping, packaging, workflows (complex-merge)
- docs/ — FAQ, TROUBLESHOOTING, BEST_PRACTICES, ARCHITECTURE, UNIFIED_PARSERS, README
- Root — BULLETPROOF_QUICKSTART, CONTRIBUTING, ROADMAP
- docs/zh-CN/ — Chinese translations for all of the above

32 files changed, +3,016 lines, -245 lines

2026-03-15 15:56:04 +03:00

5.9 KiB

Raw Blame History

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 16+ platforms.

Where Should I Start?

🚀 I'm New Here

Start with our Getting Started guides:

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

📖 I Want to Learn

Explore our User Guides:

Core Concepts - How Skill Seekers works
Scraping Guide - All scraping options
Enhancement Guide - AI enhancement explained
Packaging Guide - Export to platforms
Workflows Guide - Enhancement workflows
Troubleshooting - Common issues

📚 I Need Reference

Look up specific information:

CLI Reference - All 20 commands
MCP Reference - 26 MCP tools
Config Format - JSON specification
Environment Variables - All env vars

🚀 I'm Ready for Advanced Topics

Power user features:

MCP Server Setup - MCP integration
MCP Tools Deep Dive - Advanced MCP usage
Custom Workflows - Create workflows
Multi-Source Scraping - Combine sources

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

# 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:

I Want to Build RAG Pipelines

For LangChain, LlamaIndex, vector DBs:

I Want AI Coding Assistance

For Cursor, Windsurf, Cline:

Your First Skill
Local Codebase Analysis
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?

Edit files in the docs/ directory
Follow the existing structure
Submit a PR

See Contributing Guide 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 file.

Happy skill building! 🚀

5.9 KiB Raw Blame History