Documentation restructure: - New docs/getting-started/ guide (4 files: install, quick-start, first-skill, next-steps) - New docs/user-guide/ section (6 files: core concepts through troubleshooting) - New docs/reference/ section (CLI_REFERENCE, CONFIG_FORMAT, ENVIRONMENT_VARIABLES, MCP_REFERENCE) - New docs/advanced/ section (custom-workflows, mcp-server, multi-source) - New docs/ARCHITECTURE.md - system architecture overview - Archived legacy files (QUICKSTART.md, QUICK_REFERENCE.md, docs/guides/USAGE.md) to docs/archive/legacy/ Chinese (zh-CN) translations: - Full zh-CN mirror of all user-facing docs (getting-started, user-guide, reference, advanced) - GitHub Actions workflow for translation sync (.github/workflows/translate-docs.yml) - Translation sync checker script (scripts/check_translation_sync.sh) - Translation helper script (scripts/translate_doc.py) Content updates: - CHANGELOG.md: [Unreleased] → [3.1.0] - 2026-02-22 - README.md: updated with new doc structure links - AGENTS.md: updated agent documentation - docs/features/UNIFIED_SCRAPING.md: updated for unified scraper workflow JSON config Analysis/planning artifacts (kept for reference): - DOCUMENTATION_OVERHAUL_PLAN.md, DOCUMENTATION_OVERHAUL_SUMMARY.md - FEATURE_GAP_ANALYSIS.md, IMPLEMENTATION_GAPS_ANALYSIS.md, CREATE_COMMAND_COVERAGE_ANALYSIS.md - CHINESE_TRANSLATION_IMPLEMENTATION_SUMMARY.md, ISSUE_260_UPDATE.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
4.1 KiB
4.1 KiB
⚠️ DEPRECATED: This document is outdated and uses old CLI patterns.
For up-to-date documentation, please see:
- Quick Start Guide - 3 commands to first skill
- Installation Guide - Complete installation
- Documentation Hub - All documentation
This file is kept for historical reference only.
Quick Start Guide
🚀 3 Steps to Create a Skill
Step 1: Install Dependencies
pip3 install requests beautifulsoup4
Note: Skill_Seekers automatically checks for llms.txt files first, which is 10x faster when available.
Step 2: Run the Tool
Option A: Use a Preset (Easiest)
skill-seekers scrape --config configs/godot.json
Option B: Interactive Mode
skill-seekers scrape --interactive
Option C: Quick Command
skill-seekers scrape --name react --url https://react.dev/
Option D: Unified Multi-Source (NEW - v2.0.0)
# Combine documentation + GitHub code in one skill
skill-seekers unified --config configs/react_unified.json
Detects conflicts between docs and code automatically!
Step 3: Enhance SKILL.md (Recommended)
# LOCAL enhancement (no API key, uses Claude Code Max)
skill-seekers enhance output/godot/
This takes 60 seconds and dramatically improves the SKILL.md quality!
Step 4: Package the Skill
skill-seekers package output/godot/
Done! You now have godot.zip ready to use.
📋 Available Presets
# Godot Engine
skill-seekers scrape --config configs/godot.json
# React
skill-seekers scrape --config configs/react.json
# Vue.js
skill-seekers scrape --config configs/vue.json
# Django
skill-seekers scrape --config configs/django.json
# FastAPI
skill-seekers scrape --config configs/fastapi.json
# Unified Multi-Source (NEW!)
skill-seekers unified --config configs/react_unified.json
skill-seekers unified --config configs/django_unified.json
skill-seekers unified --config configs/fastapi_unified.json
skill-seekers unified --config configs/godot_unified.json
⚡ Using Existing Data (Fast!)
If you already scraped once:
skill-seekers scrape --config configs/godot.json
# When prompted:
✓ Found existing data: 245 pages
Use existing data? (y/n): y
# Builds in seconds!
Or use --skip-scrape:
skill-seekers scrape --config configs/godot.json --skip-scrape
🎯 Complete Example (Recommended Workflow)
# 1. Install (once)
pip3 install requests beautifulsoup4
# 2. Scrape React docs with LOCAL enhancement
skill-seekers scrape --config configs/react.json --enhance-local
# Wait 15-30 minutes (scraping) + 60 seconds (enhancement)
# 3. Package
skill-seekers package output/react/
# 4. Use react.zip in Claude!
Alternative: Enhancement after scraping
# 2a. Scrape only (no enhancement)
skill-seekers scrape --config configs/react.json
# 2b. Enhance later
skill-seekers enhance output/react/
# 3. Package
skill-seekers package output/react/
💡 Pro Tips
Test with Small Pages First
Edit config file:
{
"max_pages": 20 // Test with just 20 pages
}
Rebuild Instantly
# After first scrape, you can rebuild instantly:
skill-seekers scrape --config configs/react.json --skip-scrape
Create Custom Config
# Copy a preset
cp configs/react.json configs/myframework.json
# Edit it
nano configs/myframework.json
# Use it
skill-seekers scrape --config configs/myframework.json
📁 What You Get
output/
├── godot_data/ # Raw scraped data (reusable!)
└── godot/ # The skill
├── SKILL.md # With real code examples!
└── references/ # Organized docs
❓ Need Help?
See README.md for:
- Complete documentation
- Config file structure
- Troubleshooting
- Advanced usage
🎮 Let's Go!
# Godot
skill-seekers scrape --config configs/godot.json
# Or interactive
skill-seekers scrape --interactive
That's it! 🚀