66719cd53a
Following PR #145 which fixed README.md, this commit corrects all remaining documentation files to use the correct cli/ directory prefix for Python scripts. Changes: - QUICKSTART.md: Fixed 21 occurrences (doc_scraper.py, enhance_skill_local.py, package_skill.py) - docs/UPLOAD_GUIDE.md: Fixed 10 occurrences (doc_scraper.py, enhance_skill_local.py, package_skill.py) - docs/ENHANCEMENT.md: Fixed 9 occurrences (doc_scraper.py, enhance_skill.py, enhance_skill_local.py) All commands now correctly reference: - python3 cli/doc_scraper.py (not python3 doc_scraper.py) - python3 cli/enhance_skill.py (not python3 enhance_skill.py) - python3 cli/enhance_skill_local.py (not python3 enhance_skill_local.py) - python3 cli/package_skill.py (not python3 package_skill.py) - python3 cli/estimate_pages.py (not python3 estimate_pages.py) This ensures all documentation examples work correctly when run from the repository root directory. Related: PR #145
182 lines
3.2 KiB
Markdown
182 lines
3.2 KiB
Markdown
# Quick Start Guide
|
|
|
|
## 🚀 3 Steps to Create a Skill
|
|
|
|
### Step 1: Install Dependencies
|
|
|
|
```bash
|
|
pip3 install requests beautifulsoup4
|
|
```
|
|
|
|
### Step 2: Run the Tool
|
|
|
|
**Option A: Use a Preset (Easiest)**
|
|
```bash
|
|
python3 cli/doc_scraper.py --config configs/godot.json
|
|
```
|
|
|
|
**Option B: Interactive Mode**
|
|
```bash
|
|
python3 cli/doc_scraper.py --interactive
|
|
```
|
|
|
|
**Option C: Quick Command**
|
|
```bash
|
|
python3 cli/doc_scraper.py --name react --url https://react.dev/
|
|
```
|
|
|
|
### Step 3: Enhance SKILL.md (Recommended)
|
|
|
|
```bash
|
|
# LOCAL enhancement (no API key, uses Claude Code Max)
|
|
python3 cli/enhance_skill_local.py output/godot/
|
|
```
|
|
|
|
**This takes 60 seconds and dramatically improves the SKILL.md quality!**
|
|
|
|
### Step 4: Package the Skill
|
|
|
|
```bash
|
|
python3 cli/package_skill.py output/godot/
|
|
```
|
|
|
|
**Done!** You now have `godot.zip` ready to use.
|
|
|
|
---
|
|
|
|
## 📋 Available Presets
|
|
|
|
```bash
|
|
# Godot Engine
|
|
python3 cli/doc_scraper.py --config configs/godot.json
|
|
|
|
# React
|
|
python3 cli/doc_scraper.py --config configs/react.json
|
|
|
|
# Vue.js
|
|
python3 cli/doc_scraper.py --config configs/vue.json
|
|
|
|
# Django
|
|
python3 cli/doc_scraper.py --config configs/django.json
|
|
|
|
# FastAPI
|
|
python3 cli/doc_scraper.py --config configs/fastapi.json
|
|
```
|
|
|
|
---
|
|
|
|
## ⚡ Using Existing Data (Fast!)
|
|
|
|
If you already scraped once:
|
|
|
|
```bash
|
|
python3 cli/doc_scraper.py --config configs/godot.json
|
|
|
|
# When prompted:
|
|
✓ Found existing data: 245 pages
|
|
Use existing data? (y/n): y
|
|
|
|
# Builds in seconds!
|
|
```
|
|
|
|
Or use `--skip-scrape`:
|
|
```bash
|
|
python3 cli/doc_scraper.py --config configs/godot.json --skip-scrape
|
|
```
|
|
|
|
---
|
|
|
|
## 🎯 Complete Example (Recommended Workflow)
|
|
|
|
```bash
|
|
# 1. Install (once)
|
|
pip3 install requests beautifulsoup4
|
|
|
|
# 2. Scrape React docs with LOCAL enhancement
|
|
python3 cli/doc_scraper.py --config configs/react.json --enhance-local
|
|
# Wait 15-30 minutes (scraping) + 60 seconds (enhancement)
|
|
|
|
# 3. Package
|
|
python3 cli/package_skill.py output/react/
|
|
|
|
# 4. Use react.zip in Claude!
|
|
```
|
|
|
|
**Alternative: Enhancement after scraping**
|
|
```bash
|
|
# 2a. Scrape only (no enhancement)
|
|
python3 cli/doc_scraper.py --config configs/react.json
|
|
|
|
# 2b. Enhance later
|
|
python3 cli/enhance_skill_local.py output/react/
|
|
|
|
# 3. Package
|
|
python3 cli/package_skill.py output/react/
|
|
```
|
|
|
|
---
|
|
|
|
## 💡 Pro Tips
|
|
|
|
### Test with Small Pages First
|
|
Edit config file:
|
|
```json
|
|
{
|
|
"max_pages": 20 // Test with just 20 pages
|
|
}
|
|
```
|
|
|
|
### Rebuild Instantly
|
|
```bash
|
|
# After first scrape, you can rebuild instantly:
|
|
python3 cli/doc_scraper.py --config configs/react.json --skip-scrape
|
|
```
|
|
|
|
### Create Custom Config
|
|
```bash
|
|
# Copy a preset
|
|
cp configs/react.json configs/myframework.json
|
|
|
|
# Edit it
|
|
nano configs/myframework.json
|
|
|
|
# Use it
|
|
python3 cli/doc_scraper.py --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!
|
|
|
|
```bash
|
|
# Godot
|
|
python3 cli/doc_scraper.py --config configs/godot.json
|
|
|
|
# Or interactive
|
|
python3 cli/doc_scraper.py --interactive
|
|
```
|
|
|
|
That's it! 🚀
|