firefrost-gaming/skill-seekers-reference
3
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
5e4932e8b1fbc2f6e72581703ca1ad655d5d44f1
skill-seekers-reference/docs/getting-started/02-quick-start.md
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

381 lines
8.0 KiB
Markdown
Raw Blame History

# Quick Start Guide
> **Skill Seekers v3.2.0**
> **Create your first skill in 3 commands**
---
## The 3 Commands
```bash
# 1. Install Skill Seekers
pip install skill-seekers
# 2. Create a skill from any source
skill-seekers create https://docs.django.com/
# 3. Package it for your AI platform
skill-seekers package output/django --target claude
```
**That's it!** You now have `output/django-claude.zip` ready to upload.
---
## What You Can Create From
The `create` command auto-detects your source:
| Source Type | Example Command |
|-------------|-----------------|
| **Documentation** | `skill-seekers create https://docs.react.dev/` |
| **GitHub Repo** | `skill-seekers create facebook/react` |
| **Local Code** | `skill-seekers create ./my-project` |
| **PDF File** | `skill-seekers create manual.pdf` |
| **Word Document** | `skill-seekers create report.docx` |
| **EPUB Book** | `skill-seekers create book.epub` |
| **Video** | `skill-seekers create https://youtube.com/watch?v=...` |
| **Jupyter Notebook** | `skill-seekers create analysis.ipynb` |
| **Local HTML** | `skill-seekers create page.html` |
| **OpenAPI Spec** | `skill-seekers create api-spec.yaml` |
| **AsciiDoc** | `skill-seekers create guide.adoc` |
| **PowerPoint** | `skill-seekers create slides.pptx` |
| **RSS/Atom Feed** | `skill-seekers create feed.rss` |
| **Man Page** | `skill-seekers create grep.1` |
| **Confluence** | `skill-seekers confluence --space DEV` |
| **Notion** | `skill-seekers notion --database abc123` |
| **Slack/Discord** | `skill-seekers chat --export slack-export/` |
| **Config File** | `skill-seekers create configs/custom.json` |
---
## Examples by Source
### Documentation Website
```bash
# React documentation
skill-seekers create https://react.dev/
skill-seekers package output/react --target claude
# Django documentation
skill-seekers create https://docs.djangoproject.com/
skill-seekers package output/django --target claude
```
### GitHub Repository
```bash
# React source code
skill-seekers create facebook/react
skill-seekers package output/react --target claude
# Your own repo
skill-seekers create yourusername/yourrepo
skill-seekers package output/yourrepo --target claude
```
### Local Project
```bash
# Your codebase
skill-seekers create ./my-project
skill-seekers package output/my-project --target claude
# Specific directory
cd ~/projects/my-api
skill-seekers create .
skill-seekers package output/my-api --target claude
```
### PDF Document
```bash
# Technical manual
skill-seekers create manual.pdf --name product-docs
skill-seekers package output/product-docs --target claude
# Research paper
skill-seekers create paper.pdf --name research
skill-seekers package output/research --target claude
```
### Video
```bash
# YouTube video transcript
skill-seekers create https://www.youtube.com/watch?v=dQw4w9WgXcQ --name tutorial
skill-seekers package output/tutorial --target claude
```
### Jupyter Notebook
```bash
# Data science notebook
skill-seekers create analysis.ipynb --name ml-analysis
skill-seekers package output/ml-analysis --target claude
```
### PowerPoint / Word / EPUB
```bash
# PowerPoint slides
skill-seekers create presentation.pptx --name quarterly-review
# Word document
skill-seekers create spec.docx --name api-spec
# EPUB book
skill-seekers create rust-book.epub --name rust-guide
```
### Confluence / Notion / Slack
```bash
# Confluence wiki space
skill-seekers confluence --space DEV --name team-docs
# Notion workspace
skill-seekers notion --database abc123 --name product-wiki
# Slack/Discord export
skill-seekers chat --export slack-export/ --name team-chat
```
---
## Common Options
### Specify a Name
```bash
skill-seekers create https://docs.example.com/ --name my-docs
```
### Add Description
```bash
skill-seekers create facebook/react --description "React source code analysis"
```
### Dry Run (Preview)
```bash
skill-seekers create https://docs.react.dev/ --dry-run
```
### Skip Enhancement (Faster)
```bash
skill-seekers create https://docs.react.dev/ --enhance-level 0
```
### Use a Preset
```bash
# Quick analysis (1-2 min)
skill-seekers create ./my-project --preset quick
# Comprehensive analysis (20-60 min)
skill-seekers create ./my-project --preset comprehensive
```
---
## Package for Different Platforms
### Claude AI (Default)
```bash
skill-seekers package output/my-skill/
# Creates: output/my-skill-claude.zip
```
### Google Gemini
```bash
skill-seekers package output/my-skill/ --target gemini
# Creates: output/my-skill-gemini.tar.gz
```
### OpenAI ChatGPT
```bash
skill-seekers package output/my-skill/ --target openai
# Creates: output/my-skill-openai.zip
```
### LangChain
```bash
skill-seekers package output/my-skill/ --target langchain
# Creates: output/my-skill-langchain/ directory
```
### Multiple Platforms
```bash
for platform in claude gemini openai; do
skill-seekers package output/my-skill/ --target $platform
done
```
---
## Upload to Platform
### Upload to Claude
```bash
export ANTHROPIC_API_KEY=sk-ant-...
skill-seekers upload output/my-skill-claude.zip --target claude
```
### Upload to Gemini
```bash
export GOOGLE_API_KEY=AIza...
skill-seekers upload output/my-skill-gemini.tar.gz --target gemini
```
### Auto-Upload After Package
```bash
export ANTHROPIC_API_KEY=sk-ant-...
skill-seekers package output/my-skill/ --target claude --upload
```
---
## Complete One-Command Workflow
Use `install` for everything in one step:
```bash
# Complete: scrape → enhance → package → upload
export ANTHROPIC_API_KEY=sk-ant-...
skill-seekers install --config react --target claude
# Skip upload
skill-seekers install --config react --target claude --no-upload
```
---
## Output Structure
After running `create`, you'll have:
```
output/
├── django/ # The skill
│ ├── SKILL.md # Main skill file
│ ├── references/ # Organized documentation
│ │ ├── index.md
│ │ ├── getting_started.md
│ │ └── api_reference.md
│ └── .skill-seekers/ # Metadata
│
└── django-claude.zip # Packaged skill (after package)
```
---
## Time Estimates
| Source Type | Size | Time |
|-------------|------|------|
| Small docs (< 50 pages) | ~10 MB | 2-5 min |
| Medium docs (50-200 pages) | ~50 MB | 10-20 min |
| Large docs (200-500 pages) | ~200 MB | 30-60 min |
| GitHub repo (< 1000 files) | varies | 5-15 min |
| Local project | varies | 2-10 min |
| PDF (< 100 pages) | ~5 MB | 1-3 min |
*Times include scraping + enhancement (level 2). Use `--enhance-level 0` to skip enhancement.*
---
## Quick Tips
### Test First with Dry Run
```bash
skill-seekers create https://docs.example.com/ --dry-run
```
### Use Presets for Faster Results
```bash
# Quick mode for testing
skill-seekers create https://docs.react.dev/ --preset quick
```
### Skip Enhancement for Speed
```bash
skill-seekers create https://docs.react.dev/ --enhance-level 0
skill-seekers enhance output/react/ # Enhance later
```
### Check Available Configs
```bash
skill-seekers estimate --all
```
### Resume Interrupted Jobs
```bash
skill-seekers resume --list
skill-seekers resume <job-id>
```
---
## Next Steps
- [Your First Skill](03-your-first-skill.md) - Complete walkthrough
- [Core Concepts](../user-guide/01-core-concepts.md) - Understand how it works
- [Scraping Guide](../user-guide/02-scraping.md) - All scraping options
---
## Troubleshooting
### "command not found"
```bash
# Add to PATH
export PATH="$HOME/.local/bin:$PATH"
```
### "No module named 'skill_seekers'"
```bash
# Reinstall
pip install --force-reinstall skill-seekers
```
### Scraping too slow
```bash
# Use async mode
skill-seekers create https://docs.react.dev/ --async --workers 5
```
### Out of memory
```bash
# Use streaming mode
skill-seekers package output/large-skill/ --streaming
```
---
## See Also
- [Installation Guide](01-installation.md) - Detailed installation
- [CLI Reference](../reference/CLI_REFERENCE.md) - All commands
- [Config Format](../reference/CONFIG_FORMAT.md) - Custom configurations
Reference in New Issue View Git Blame Copy Permalink