Fix CLI path references in documentation

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
This commit is contained in:
yusyus
2025-10-22 21:33:26 +03:00
parent 9fcfc139bc
commit 66719cd53a
3 changed files with 39 additions and 39 deletions

View File

@@ -12,24 +12,24 @@ pip3 install requests beautifulsoup4
**Option A: Use a Preset (Easiest)**
```bash
python3 doc_scraper.py --config configs/godot.json
python3 cli/doc_scraper.py --config configs/godot.json
```
**Option B: Interactive Mode**
```bash
python3 doc_scraper.py --interactive
python3 cli/doc_scraper.py --interactive
```
**Option C: Quick Command**
```bash
python3 doc_scraper.py --name react --url https://react.dev/
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 enhance_skill_local.py output/godot/
python3 cli/enhance_skill_local.py output/godot/
```
**This takes 60 seconds and dramatically improves the SKILL.md quality!**
@@ -37,7 +37,7 @@ python3 enhance_skill_local.py output/godot/
### Step 4: Package the Skill
```bash
python3 package_skill.py output/godot/
python3 cli/package_skill.py output/godot/
```
**Done!** You now have `godot.zip` ready to use.
@@ -48,19 +48,19 @@ python3 package_skill.py output/godot/
```bash
# Godot Engine
python3 doc_scraper.py --config configs/godot.json
python3 cli/doc_scraper.py --config configs/godot.json
# React
python3 doc_scraper.py --config configs/react.json
python3 cli/doc_scraper.py --config configs/react.json
# Vue.js
python3 doc_scraper.py --config configs/vue.json
python3 cli/doc_scraper.py --config configs/vue.json
# Django
python3 doc_scraper.py --config configs/django.json
python3 cli/doc_scraper.py --config configs/django.json
# FastAPI
python3 doc_scraper.py --config configs/fastapi.json
python3 cli/doc_scraper.py --config configs/fastapi.json
```
---
@@ -70,7 +70,7 @@ python3 doc_scraper.py --config configs/fastapi.json
If you already scraped once:
```bash
python3 doc_scraper.py --config configs/godot.json
python3 cli/doc_scraper.py --config configs/godot.json
# When prompted:
✓ Found existing data: 245 pages
@@ -81,7 +81,7 @@ Use existing data? (y/n): y
Or use `--skip-scrape`:
```bash
python3 doc_scraper.py --config configs/godot.json --skip-scrape
python3 cli/doc_scraper.py --config configs/godot.json --skip-scrape
```
---
@@ -93,11 +93,11 @@ python3 doc_scraper.py --config configs/godot.json --skip-scrape
pip3 install requests beautifulsoup4
# 2. Scrape React docs with LOCAL enhancement
python3 doc_scraper.py --config configs/react.json --enhance-local
python3 cli/doc_scraper.py --config configs/react.json --enhance-local
# Wait 15-30 minutes (scraping) + 60 seconds (enhancement)
# 3. Package
python3 package_skill.py output/react/
python3 cli/package_skill.py output/react/
# 4. Use react.zip in Claude!
```
@@ -105,13 +105,13 @@ python3 package_skill.py output/react/
**Alternative: Enhancement after scraping**
```bash
# 2a. Scrape only (no enhancement)
python3 doc_scraper.py --config configs/react.json
python3 cli/doc_scraper.py --config configs/react.json
# 2b. Enhance later
python3 enhance_skill_local.py output/react/
python3 cli/enhance_skill_local.py output/react/
# 3. Package
python3 package_skill.py output/react/
python3 cli/package_skill.py output/react/
```
---
@@ -129,7 +129,7 @@ Edit config file:
### Rebuild Instantly
```bash
# After first scrape, you can rebuild instantly:
python3 doc_scraper.py --config configs/react.json --skip-scrape
python3 cli/doc_scraper.py --config configs/react.json --skip-scrape
```
### Create Custom Config
@@ -141,7 +141,7 @@ cp configs/react.json configs/myframework.json
nano configs/myframework.json
# Use it
python3 doc_scraper.py --config configs/myframework.json
python3 cli/doc_scraper.py --config configs/myframework.json
```
---
@@ -172,10 +172,10 @@ See **README.md** for:
```bash
# Godot
python3 doc_scraper.py --config configs/godot.json
python3 cli/doc_scraper.py --config configs/godot.json
# Or interactive
python3 doc_scraper.py --interactive
python3 cli/doc_scraper.py --interactive
```
That's it! 🚀

View File

@@ -27,10 +27,10 @@ Both analyze reference documentation and extract the best examples and guidance.
```bash
# Option 1: Standalone enhancement
python3 enhance_skill_local.py output/steam-inventory/
python3 cli/enhance_skill_local.py output/steam-inventory/
# Option 2: Integrated with scraper
python3 doc_scraper.py --config configs/steam-inventory.json --enhance-local
python3 cli/doc_scraper.py --config configs/steam-inventory.json --enhance-local
```
**What happens:**
@@ -61,20 +61,20 @@ pip3 install anthropic
export ANTHROPIC_API_KEY=sk-ant-...
# Option 2: Pass directly with --api-key
python3 enhance_skill.py output/react/ --api-key sk-ant-...
python3 cli/enhance_skill.py output/react/ --api-key sk-ant-...
```
### Usage
```bash
# Standalone enhancement
python3 enhance_skill.py output/steam-inventory/
python3 cli/enhance_skill.py output/steam-inventory/
# Integrated with scraper
python3 doc_scraper.py --config configs/steam-inventory.json --enhance
python3 cli/doc_scraper.py --config configs/steam-inventory.json --enhance
# Dry run (see what would be done)
python3 enhance_skill.py output/react/ --dry-run
python3 cli/enhance_skill.py output/react/ --dry-run
```
## What It Does
@@ -137,13 +137,13 @@ bool success = SteamInventory()->GetAllItems( &resultHandle );
```bash
export ANTHROPIC_API_KEY=sk-ant-...
# or
python3 enhance_skill.py output/react/ --api-key sk-ant-...
python3 cli/enhance_skill.py output/react/ --api-key sk-ant-...
```
### "No reference files found"
Make sure you've run the scraper first:
```bash
python3 doc_scraper.py --config configs/react.json
python3 cli/doc_scraper.py --config configs/react.json
```
### "anthropic package not installed"
@@ -157,7 +157,7 @@ pip3 install anthropic
mv output/steam-inventory/SKILL.md.backup output/steam-inventory/SKILL.md
# Try again (it may generate different content)
python3 enhance_skill.py output/steam-inventory/
python3 cli/enhance_skill.py output/steam-inventory/
```
## Tips

View File

@@ -80,7 +80,7 @@ The package script:
**Example:**
```bash
python3 package_skill.py output/steam-economy/
python3 cli/package_skill.py output/steam-economy/
📦 Packaging skill: steam-economy
Source: output/steam-economy
@@ -99,7 +99,7 @@ python3 package_skill.py output/steam-economy/
### Step 1: Scrape & Build
```bash
python3 doc_scraper.py --config configs/steam-economy.json
python3 cli/doc_scraper.py --config configs/steam-economy.json
```
**Output:**
@@ -108,7 +108,7 @@ python3 doc_scraper.py --config configs/steam-economy.json
### Step 2: Enhance (Recommended)
```bash
python3 enhance_skill_local.py output/steam-economy/
python3 cli/enhance_skill_local.py output/steam-economy/
```
**What it does:**
@@ -122,7 +122,7 @@ python3 enhance_skill_local.py output/steam-economy/
### Step 3: Package
```bash
python3 package_skill.py output/steam-economy/
python3 cli/package_skill.py output/steam-economy/
```
**Output:**
@@ -181,7 +181,7 @@ Claude has generous size limits, so most documentation-based skills fit easily.
### Package a Skill
```bash
python3 package_skill.py output/steam-economy/
python3 cli/package_skill.py output/steam-economy/
```
### Package Multiple Skills
@@ -189,7 +189,7 @@ python3 package_skill.py output/steam-economy/
# Package all skills in output/
for dir in output/*/; do
if [ -f "$dir/SKILL.md" ]; then
python3 package_skill.py "$dir"
python3 cli/package_skill.py "$dir"
fi
done
```
@@ -212,10 +212,10 @@ cat temp-test/SKILL.md
### "SKILL.md not found"
```bash
# Make sure you scraped and built first
python3 doc_scraper.py --config configs/steam-economy.json
python3 cli/doc_scraper.py --config configs/steam-economy.json
# Then package
python3 package_skill.py output/steam-economy/
python3 cli/package_skill.py output/steam-economy/
```
### "Directory not found"
@@ -224,7 +224,7 @@ python3 package_skill.py output/steam-economy/
ls output/
# Use correct path
python3 package_skill.py output/YOUR-SKILL-NAME/
python3 cli/package_skill.py output/YOUR-SKILL-NAME/
```
### Zip is Too Large